simon/pastoralist
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Made README (a little) more useful.

Browse source
This commit is contained in:
Simon Brooke 2019-12-27 12:31:48 +00:00
parent 649082871b
commit ee0d6ecd4e
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -5,12 +5,35 @@ generated using Luminus version "3.54"
A web-app intended to be used by pastoralists in managing A web-app intended to be used by pastoralists in managing
pastures, grazing, and animals. pastures, grazing, and animals.
## WARNING
Preliminary code; nothing at all works yet.
## Prerequisites ## Prerequisites
You will need [Leiningen][1] 2.0 or above installed. You will need [Leiningen][1] 2.0 or above installed.
[1]: https://github.com/technomancy/leiningen [1]: https://github.com/technomancy/leiningen
## Building
To generate the majority of the code, run
lein adl
**NOTE THAT** currently this relies on development versions of the ADL framework; in order to work for you locally, this requires that you check out the development branches of each of
1. [adl-support](https://github.com/simon-brooke/adl-support/)
2. [adl](https://github.com/simon-brooke/adl); and
3. [lein-adl](https://github.com/simon-brooke/lein-adl)
And, in each repository in the order listed above, run
lein test
lein install
All tests should pass. This will install the development versions locally.
## Running ## Running
To start a web server for the application, run: To start a web server for the application, run: