Updated README.md to note LFS needs

This commit is contained in:
DataHoarder 2022-02-20 14:47:05 +01:00
parent 1b0d5a850a
commit 48a12eae83

View file

@ -2,9 +2,11 @@
Small collection of scripts to mirror Doujin CDs raw text and templates from [Touhou Wiki](https://en.touhouwiki.net/) for offline querying.
Also includes data fetched under [data/](data/).
This repository also includes content fetched stored under [data/](data/). Files are tracked under Git LFS.
# Usage
You will need `git-lfs` package installed, and run at least one `$ git lfs install --skip-repo` command before to set up filter commands.
* `$ git clone https://git.gammaspectra.live/S.O.N.G/touhouwiki-mirror.git` to clone the repository.
* `$ ./all.sh` to do a full run updating where necessary
* `$ ./mirror.sh "<category name>" force` if fetching all pages of a category is necessary.
* `$ go run . -path data/` for running a server. Opens on port 8777.