SoniEx2/ganarchy
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README

Browse source
This commit is contained in:
SoniEx2 2019-05-22 20:18:33 -03:00
parent 4c47abad7e
commit cb63969424
1 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -4,8 +4,8 @@ GAnarchy
GAnarchy is a Project Page Generator focused on giving forks of a project the same visibility as the original repo. GAnarchy is a Project Page Generator focused on giving forks of a project the same visibility as the original repo.
More importantly, it's a tool to help fight against BDFLs and other forms of centralized project management. More importantly, it's a tool to help fight against BDFLs and other forms of centralized project management.
Usage Basic 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`). 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 The protocol handler uses the path `/?url=%s`. Additionally, your main page needs to include the `index.js` provided by GAnarchy
@ -18,8 +18,8 @@ The commit *must* start with `[Project]` followed by the project name, and may h
(Note: This requirement isn't properly checked, but will be in the future. This is important for a future federation (Note: This requirement isn't properly checked, but will be in the future. This is important for a future federation
protocol that allows for automatically discovering forks based on the project commit.) protocol that allows for automatically discovering forks based on the project commit.)
Once everything is initialized, add some repos with `ganarchy.py repo add URL`, and enable them with `ganarchy.py repo enable URL` Once everything is initialized, add some repos with `ganarchy.py repo add URL`, and enable or disable them with `ganarchy.py repo enable URL` or
(they come disabled by default). You are now ready to go. `ganarchy.py repo disable URL`. They currently come enabled by default. You are now ready to go.
Finally, add `ganarchy.py cron-target > path/to/page.html` to your cron. Optionally `scp page.html scp://server@example.org/page.html`. Finally, add `ganarchy.py cron-target > path/to/page.html` to your cron. Optionally `scp page.html scp://server@example.org/page.html`.
@ -30,7 +30,6 @@ $ ganarchy.py initdb
$ ganarchy.py set-commit 385e734a52e13949a7a5c71827f6de920dbfea43 $ ganarchy.py set-commit 385e734a52e13949a7a5c71827f6de920dbfea43
$ ganarchy.py set-project-name GAnarchy $ ganarchy.py set-project-name GAnarchy
$ ganarchy.py repo add https://cybre.tech/SoniEx2/ganarchy $ ganarchy.py repo add https://cybre.tech/SoniEx2/ganarchy
$ ganarchy.py repo enable https://cybre.tech/SoniEx2/ganarchy
$ ganarchy.py cron-target > index.html $ ganarchy.py cron-target > index.html
$ scp index.html scp://example.org/var/www/html/index.html $ scp index.html scp://example.org/var/www/html/index.html
``` ```
@ -43,3 +42,14 @@ Example project commit:
A Project Page Generator written in Python, focused on giving forks of a A Project Page Generator written in Python, focused on giving forks of a
project the same visibility as the original repo. project the same visibility as the original repo.
``` ```
Advanced Usage
--------------
It's also possible to use the same GAnarchy DB with multiple projects. This is currently done by passing `--project COMMIT` to the `repo` commands,
and using `cron-target COMMIT`.
Note that the same repo may be part of multiple projects, so it is necessary to specify `--project COMMIT` also when enabling/disabling it.
Additionally, it's possible to set a non-default branch by passing `--branch BRANCHNAME` to the `repo` commands. Given that multiple branches of
the same repo may be part of the same project, it is also necessary to use `--branch BRANCHNAME` when enabling/disabling them.