Update README
This commit is contained in:
parent
8bff8f3ca6
commit
6750898bf2
18
README.md
18
README.md
|
@ -10,8 +10,22 @@ A project whose goal is to centralize accident reports and make them easier to a
|
|||
* [pup](https://github.com/ericchiang/pup): `go get github.com/ericchiang/pup`
|
||||
* [jq](https://stedolan.github.io/jq/): `sudo apt install jq`
|
||||
* [xmltodict](https://github.com/martinblech/xmltodict): `pip install xmltodict`
|
||||
* Add [`bin/json2xml`](bin/json2xml) to your `$PATH`
|
||||
* [xsltproc](http://xmlsoft.org/XSLT/xsltproc.html): `sudo apt install xsltproc`
|
||||
* Clone this repository
|
||||
* Add the repo's [`bin`](bin/) directory to your `$PATH`
|
||||
|
||||
## Usage
|
||||
|
||||
Run [`feedgen.sh`](feedgen.sh) to build the RSS feeds. You can add this script to CRON to build the feeds regularly.
|
||||
### Manual build
|
||||
|
||||
Run [`feedgen.sh`](feedgen.sh) to build the feeds.
|
||||
|
||||
### Automated build
|
||||
|
||||
You can build the feeds automatically by adding the bash script to CRON.
|
||||
|
||||
This is the line I am currently using to build on tilde.town once a day:
|
||||
|
||||
```
|
||||
37 13 * * * nice -n 19 bash -c "PATH=/home/lucidiot/bin:/home/lucidiot/go/bin:$PATH /home/lucidiot/dev/itsb/feedgen.sh -q"
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue