From bacbd0f806776107a542bfe209fd5fbdf0b4da9b Mon Sep 17 00:00:00 2001
From: cupcakearmy <hi@nicco.io>
Date: Fri, 23 Apr 2021 12:31:24 +0200
Subject: [PATCH] docs

---
 DEVELOPMENT.md | 23 +++++++++++++++++++++++
 README.md      |  5 +++++
 RELEASE.md     |  9 ---------
 3 files changed, 28 insertions(+), 9 deletions(-)
 create mode 100644 DEVELOPMENT.md
 delete mode 100644 RELEASE.md

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
new file mode 100644
index 0000000..acb3dad
--- /dev/null
+++ b/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.
diff --git a/README.md b/README.md
index 5181cbf..7b8b580 100644
--- a/README.md
+++ b/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)
diff --git a/RELEASE.md b/RELEASE.md
deleted file mode 100644
index 20c3278..0000000
--- a/RELEASE.md
+++ /dev/null
@@ -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.