docs(README): update source build instructions

This commit is contained in:
Jordan Knott 2020-09-10 15:53:47 -05:00
parent 0caa803d27
commit 09d73fdbce

View File

@ -90,6 +90,7 @@ The newly created `taskcafe` binary can be found in the __dist__ folder.
It contains everything neccessary to run except the config file. An example config file can be found in `conf/app.example.toml`. It contains everything neccessary to run except the config file. An example config file can be found in `conf/app.example.toml`.
For more information on configuration, please read the [wiki](https://github.com/JordanKnott/taskcafe/wiki/Configuration).
The config will need to be copied to a `conf/app.toml` in the same place the binary is. The config will need to be copied to a `conf/app.toml` in the same place the binary is.
Make sure to fill out the database section of the config in order to connect it to your database. Make sure to fill out the database section of the config in order to connect it to your database.
@ -98,6 +99,8 @@ Then run the database migrations with `taskcafe migrate`.
Now you can run the web interface by running `taskcafe web`. Now you can run the web interface by running `taskcafe web`.
[A more detailed guide for installing on Ubuntu/Debian](https://github.com/JordanKnott/taskcafe/wiki/Installation-(ubuntu-debian))
## How is this different from X (Trello, NextCloud, etc)? ## How is this different from X (Trello, NextCloud, etc)?
One of the primary goals of Taskcafe is to provide a project management tool that I personally enjoy using for my One of the primary goals of Taskcafe is to provide a project management tool that I personally enjoy using for my