From ee0d6ecd4e621935bf410c0517ea8c93b21b1c42 Mon Sep 17 00:00:00 2001 From: Simon Brooke <simon@journeyman.cc> Date: Fri, 27 Dec 2019 12:31:48 +0000 Subject: [PATCH] Made README (a little) more useful. --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index a577970..70c995c 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,35 @@ generated using Luminus version "3.54" A web-app intended to be used by pastoralists in managing pastures, grazing, and animals. +## WARNING + +Preliminary code; nothing at all works yet. + ## Prerequisites You will need [Leiningen][1] 2.0 or above installed. [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 To start a web server for the application, run: