contributing docs

README.md

@@ -18,24 +18,12 @@ Note that this does not come with Podman or Distrobox, those will need to be ins
 - Download and unzip the release
 - Execute `./install.sh`
 
+## Contributing
 
-## Developing
+Please see the dedicated [contributing.md file](https://github.com/Dvlv/BoxBuddyRS/blob/master/docs/CONTRIBUTING.md)
 
-Boxbuddy is written with Rust using Gtk4 and Libadwaita.
-
-### Building Flatpak
-- Install `flatpak-builder`
-- `./singlefile.sh`
-- `flatpak install --user boxbuddy.flatpak`
-
-### Running Locally
-- Install gtk4 development packages - check your distro for something like `gtk4-devel` or `gtk-dev`, etc.
-- Install `rustup`
-- Use the standard `cargo run` / `cargo build` workflow
-
-## Issues & Feature Requests
+## Issues / Feature Requests
 
 Feature requests are welcome! Please check the [roadmap](https://github.com/Dvlv/BoxBuddyRS/blob/master/docs/ROADMAP.md) to see if a feature is already planned.
 
 When filing issues, please keep in mind that BoxBuddy is just a GUI, and I am not a developer of Distrobox itself. Any issues with created boxes are probably better logged [upstream.](https://github.com/89luca89/distrobox/issues)
-

docs/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing
+
+Thank you for considering contributing to BoxBuddy!
+
+## Developing
+
+BoxBuddy is built with Rust, and uses a standard `cargo` workflow.
+
+### Dependencies
+
+You need the GTK4 and Libadwaita development packages.
+
+**Fedora** / **openSUSE** - `gtk4-devel libadwaita-devel`
+
+**Debian** - `libgtk-4-dev libadwaita-1-dev`
+
+**Arch** - `gtk4 libadwaita`
+
+You will also need Rust, probably via [Rustup](https://rustup.rs/)
+
+Install stable Rust via:
+
+```bash
+rustup toolchain add stable
+```
+
+### Building / Running
+
+```bash
+cargo run
+```
+
+### Building Flatpak
+
+- Install `flatpak-builder`
+- Execute the singlefile script: `./singlefile.sh`
+- Install the bundle: `flatpak install --user boxbuddy.flatpak`
+
+### Coding Guidelines
+
+Please run `cargo fmt` and `cargo clippy` before submitting code.
+
+Try to avoid adding external crates unless absolutely necessary.
+
+## Translations
+
+Translations are much appreciated. There are instructions in the [po folder.](https://github.com/Dvlv/BoxBuddyRS/tree/master/po)
+
+## Issues / Feature Requests
+
+Feature requests are welcome! Please check the [roadmap](https://github.com/Dvlv/BoxBuddyRS/blob/master/docs/ROADMAP.md) to see if a feature is already planned.
+
+When filing issues, please keep in mind that BoxBuddy is just a GUI, and I am not a developer of Distrobox itself. Any issues with created boxes are probably better logged [upstream.](https://github.com/89luca89/distrobox/issues)