Browse Source

docs: Add basic contributing details to README

As a new contributor (maybe just because I haven't used Rust before) I didn't easily see how to get started. If this is too much here, happy just to have a link to the wiki page on building the binary which I only found after quite some digging (as I initially searched 'contributing' and 'developing').
pull/1990/head
Adam Jones 4 years ago
parent
commit
145487bb9d
No known key found for this signature in database GPG Key ID: B3D3399C05B09A00
  1. 10
      README.md

10
README.md

@ -55,6 +55,16 @@ If you spot any bugs or crashes with vaultwarden itself, please [create an issue
If you prefer to chat, we're usually hanging around at [#vaultwarden:matrix.org](https://matrix.to/#/#vaultwarden:matrix.org) room on Matrix. Feel free to join us! If you prefer to chat, we're usually hanging around at [#vaultwarden:matrix.org](https://matrix.to/#/#vaultwarden:matrix.org) room on Matrix. Feel free to join us!
## Contributing
To get started with development:
1. [Install Rust](https://www.rust-lang.org/tools/install)
2. Create the data directory with `mkdir data`
3. Download and extract the [latest bw_web_builds](https://github.com/dani-garcia/bw_web_builds/releases/latest) artifact to a `web-vault` folder.
4. Run `cargo run --features sqlite --release` (alternatively `mysql` or `postgresql`)
For full details, see [the vaultwarden wiki](https://github.com/dani-garcia/vaultwarden/wiki/Building-binary).
### Sponsors ### Sponsors
Thanks for your contribution to the project! Thanks for your contribution to the project!

Loading…
Cancel
Save