Commit 86559727 authored by Robert Czechowski's avatar Robert Czechowski
Browse files

Update README.md: Add note to use rustfmt and clippy

parent e051daa6
......@@ -23,6 +23,33 @@ It is designed for the German Jugendwettbewerb Informatik, a computer science co
Needs `rustc` 1.28 (stable) or higher (cf. https://rustup.rs/).
Running `make` compiles and runs a debug-/test-server.
Running
```
make
```
compiles and runs a debug-/test-server.
For production use, a release binary should be compiled and served behind a reverse proxy (nginx, apache, …).
```
make release
```
compiles a release build with openssl statically linked for distribution.
The directories `tasks/` and `static/` can (and for throughput-purposes should) be served by the reverse proxy directly.
## Contributing
Please format your code with `rustfmt` and check it for warnings with `clippy`.
You can install those with
```
rustup component add rustfmt
rustup component add clippy
```
Format the code and check for warnings with
```
cargo fmt
make clippy
```
For production use, a release binary should be compiled and served behind a reveres proxy (nginx, apache, …). The directories `tasks/` and `static/` can (and for throughput-purposes should) be served by the reverse proxy directly.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment