Add README
This commit is contained in:
parent
2e9ad534a1
commit
7318ec2041
19
README.md
Normal file
19
README.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# Bugspray
|
||||
|
||||
A simple issue tracking app written entirely in Rust.
|
||||
|
||||
To build locally, you need to install the latest nightly Rust, and you need to add the `wasm32-unkown-unknown` target:
|
||||
```sh
|
||||
rustup override set nightly # TODO: make a rustup.toml
|
||||
rustup target add wasm32-unknown-unknown
|
||||
```
|
||||
|
||||
Then, simply run `./build.sh` and then run the compiled executable.
|
||||
|
||||
Make sure to set the BUGSPRAY_DB environment variable so that bugspray can populate your database.
|
||||
|
||||
TODO:
|
||||
- [ ] User registration
|
||||
- [ ] User login
|
||||
- [ ] Comments
|
||||
- [ ] Open/Close issues
|
Loading…
Reference in a new issue