diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md index b8cdc58..39c1953 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,10 @@ More importantly, it's a tool to help fight against BDFLs and other forms of cen Usage ----- +Note: GAnarchy does not come with a main page. You need to provide one yourself. This should be in your website's `/` path (usually `index.html`). +The protocol handler uses the path `/?url=%s`. Additionally, your main page needs to include the `index.js` provided by GAnarchy +for the protocol handler to properly work. + First, initialize the database with `ganarchy.py initdb`. The database is stored in the XDG data home, as per XDG spec. Then, set the project commit with `ganarchy.py set-commit COMMIT`, where `COMMIT` is the full commit hash. |