docs

DEVELOPMENT.md

@@ -0,0 +1,23 @@
+# Development
+
+## Coding
+
+The easiest way (imo) is to run [`gowatch`](https://github.com/silenceper/gowatch) in a separate terminal and the simply run `./autorestic ...`. `gowatch` will watch the code and automatically rebuild the binary when changes are saved to disk.
+
+## Building
+
+```bash
+go run build/build.go
+```
+
+This will build and compress binaries for multiple platforms. The output will be put in the `dist` folder.
+
+## Releasing
+
+Releases are automatically built by the github workflow and uploaded to the release.
+
+1. Bump `VERSION` in `internal/config.go`.
+2. Update `CHANGELOG.md`
+3. Commit to master
+4. Create a new release with the `v1.2.3` tag and mark as draft.
+5. The Github action will build the binaries, upload and mark the release as ready when done.

README.md

@@ -36,3 +36,8 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
 ### ❓ Questions / Support
 
 Check the [discussions page](https://github.com/cupcakearmy/autorestic/discussions)
+
+## Contributing / Developing
+
+PRs, feature requests, etc. are welcomed :)
+Have a look at [the dev docs](./DEVELOPMENT.md)

RELEASE.md

@@ -1,9 +0,0 @@
-# Releasing
-
-Releases are automatically built by the github workflow and uploaded to the release.
-
-1. Bump `VERSION` in `internal/config.go`.
-2. Update `CHANGELOG.md`
-3. Commit to master
-4. Create a new release with the `v1.2.3` tag and mark as draft.
-5. The Github action will build the binaries, upload and mark the release as ready when done.