From 60530d825a0ff560808cea06da7ec81cd043c2b9 Mon Sep 17 00:00:00 2001
From: Tim Schaefer <ts+code@rcmd.org>
Date: Wed, 24 Apr 2024 11:59:30 +0200
Subject: [PATCH] CHG: Move dev info to separate Readme file

---
 Cargo.toml    |  2 +-
 README.md     | 12 ++----------
 README_DEV.md | 31 +++++++++++++++++++++++++++++++
 3 files changed, 34 insertions(+), 11 deletions(-)
 create mode 100644 README_DEV.md

diff --git a/Cargo.toml b/Cargo.toml
index cbebc6e..0698810 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "neuroformats"
-version = "0.2.3"
+version = "0.2.4"
 authors = ["Tim Schäfer <ts+code@rcmd.org>"]
 edition = "2018"
 repository = "https://github.com/dfsp-spirit/neuroformats-rs"
diff --git a/README.md b/README.md
index e2eb7af..c42b992 100644
--- a/README.md
+++ b/README.md
@@ -64,17 +64,9 @@ There is a small command line demo application that loads a brain surface mesh a
 See the [neuroformats API docs](https://docs.rs/neuroformats) and the [unit tests in the source code](./src/) for more examples.
 
 
-## Development
+## Development Info
 
-### Unit tests and continuous integration
-
-Run `cargo test` in the repository root to run the tests locally.
-
-Continuous integration results:
-
-main branch: ![main](https://github.com/dfsp-spirit/neuroformats-rs/actions/workflows/tests.yml/badge.svg?branch=main)
-
-develop branch: ![main](https://github.com/dfsp-spirit/neuroformats-rs/actions/workflows/tests.yml/badge.svg?branch=develop)
+Please see the [README_DEV file](./README_DEV.md).
 
 
 ### LICENSE
diff --git a/README_DEV.md b/README_DEV.md
new file mode 100644
index 0000000..89c5b14
--- /dev/null
+++ b/README_DEV.md
@@ -0,0 +1,31 @@
+# Developer information for neuroformats-rs
+
+## Running the unit tests
+
+Run `cargo test` in the repository root to run the tests locally.
+
+
+Continuous integration results:
+
+main branch: ![main](https://github.com/dfsp-spirit/neuroformats-rs/actions/workflows/tests.yml/badge.svg?branch=main)
+
+develop branch: ![main](https://github.com/dfsp-spirit/neuroformats-rs/actions/workflows/tests.yml/badge.svg?branch=develop)
+
+
+## Publishing a new release
+
+* Update the [CHANGES file](./CHANGES)
+* Bump version information in [Cargo.toml](./Cargo.toml)
+* Run the unit tests
+* Once everything is ready, publish to crates.io via ```cargo```:
+
+```shell
+cargo login
+cargo publish --dry-run
+```
+
+And when you are satisfied with the result:
+
+```shell
+cargo publish
+```