Skip to content

Commit

Permalink
CHG: Move dev info to separate Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
dfsp-spirit committed Apr 24, 2024
1 parent 8577b08 commit 60530d8
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "neuroformats"
version = "0.2.3"
version = "0.2.4"
authors = ["Tim Schäfer <[email protected]>"]
edition = "2018"
repository = "https://github.com/dfsp-spirit/neuroformats-rs"
Expand Down
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
31 changes: 31 additions & 0 deletions README_DEV.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 60530d8

Please sign in to comment.