diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc49c71 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# fLotte User Management Server + +## Dev Requirements + +- a full rust toolchain installation (for example with [rustup](https://rustup.rs/)) +- a postgres installation + +## Building + +```sh +# in the projects folder +> cargo build --release +``` + +The resulting binary is being stored in the `target` folder. + + +## Running + +The server can be run either directly from the built binary or with the command + +```sh +cargo run --release +``` + +The `--release` indicates that an optimized release built should be run.