Skip to content

Commit 4c0b03c

Browse files
readme update
1 parent aeb47a0 commit 4c0b03c

2 files changed

Lines changed: 25 additions & 4 deletions

File tree

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,29 @@ Vesalius has been tested on:
5050
* Red Hat Enterprise Linux 8.5 (Ootpa)
5151

5252

53-
## What's next?
54-
The Vesalius package is in its early stage of development. We would ask you to
55-
share with us any bugs, concerns, or features you wish to see implemented.
53+
54+
## Contributing
55+
56+
New interoperablity functions will be added in the near future. Other from
57+
these quality-of-life functions, no other active development projects are planned.
58+
59+
If you have any feature you would like to add, please feel free to open a Pull request. The package is still actively maintained.
60+
61+
To faciliate contribution, we recommend using Nix to set up a stable development environment. You can download Nix [here](https://nixos.org/download/). Note that Nix does not run on Windows; you will need to use the Windows Linux Subsytem (WLS) to run nix. Make sure to enable Nix Flakes.
62+
63+
Once you have Nix installed, clone the current repository and run:
64+
65+
```
66+
cd vesalius
67+
nix develop
68+
```
69+
70+
Nix will derive a reproducible shell environment in which you can proceed with any development you wish.
71+
72+
==NOTE: Nix is a purely function package manager.== As such, to add new packages, you will need to modify the nix flake by adding your desired package to the `rPackages` list. GitHub packages will need to be added seperately.
73+
74+
Before any pull request, please make sure that your features are covered by the appropriate unit test, are documented using `roxygen2` style comments, and that `R CMD build` and `R CMD check` pass with no warnings or errors. Pull requests will trigger a GitHub `R CMD check` but we would like to minimize the number of times this is triggered.
75+
76+
## Issues
5677

5778
Please open a GitHub issue or send an email to Patrick Martin (Patrick.Martin@cshs.org)

tests/testthat.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
library(testthat)
22
library(vesalius)
3-
usethis::use_package("rlang")
3+
library(rlang)
44
test_check("vesalius")

0 commit comments

Comments
 (0)