commit f2ee459e7e2fd344fbb284eead4ee0275c00ccc4 parent 419e8a18143bc8adb994476383df50971216bbbe Author: srfsh <dev@srf.sh> Date: Mon, 20 Jun 2022 16:50:56 +0300 readme: convert into .md Diffstat:
| D | README | | | 16 | ---------------- |
| A | README.md | | | 19 | +++++++++++++++++++ |
2 files changed, 19 insertions(+), 16 deletions(-)
diff --git a/README b/README @@ -1,16 +0,0 @@ -Zenflows -======== - - -How to get started ------------------- - -1. Edit `conf/dev.exs' and `conf/test.exs' to suit your needs. -2. Run `./mann db.create && ./mann db.migrate && ./mann run'. -3. Head over to `localhost:8000/play' for the playground. - - -Licensing and copying ---------------------- - -See the LICENSE file for copyright and license details. diff --git a/README.md b/README.md @@ -0,0 +1,19 @@ +# Zenflows + +Zenflows is a back-end software implementing the [Valueflows +vocabulary](https://www.valueflo.ws/). + + +## Quick start + +1. Run `./mann env.setup` to generate the configuration file, `conf/env.sh`. +2. Edit `conf/env.sh` to suit your needs. Read the [Configuration + Guide](docs/configuration-guide.md) for more info. +3. Run `./mann db.setup` to setup the database and run the migrations. +4. Run `./mann run` to start the application. +5. Head over to [`http://localhost:4000/play`](http://localhost:4000/play) for the GraphQL playground. + + +## Licensing and copying + +See the [LICENSE](LICENSE) file for copyright and license details.