Skip to content

Commit 1a73670

Browse files
committed
doc: readme polishing
1 parent 9a77c0a commit 1a73670

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,18 @@
1010
<!-- badges: end -->
1111

1212
The goal of *natcpp* is to provide accelerated routines through compiled C++
13-
code for basic functions to support the [natverse](https://natverse.org) computational neuroanatomy ecosystem.
13+
code for basic functions to support the [natverse](https://natverse.org)
14+
computational neuroanatomy ecosystem.
1415
*natcpp* is not designed to be used by end users but instead the
1516
[nat](https://natverse.org/nat/) package will use it when available to enable
16-
large speed-ups for some primitive operations. End users should therefore not count on the *natcpp* functions/interface being stable, especially during its
17+
large speed-ups for some primitive operations. End users should therefore not
18+
count on the *natcpp* functions/interface being stable, especially during its
1719
initial development.
1820

1921
Our plan is to get this onto
20-
CRAN quite quickly so that binary packages will be available to Mac/Windows users who do not have a full C compiler toolchain installed. Once on CRAN, we will try to keep the package simple and stable, with infrequent
22+
CRAN quite quickly so that binary packages will be available to Mac/Windows
23+
users who do not have a full C compiler toolchain installed. Once on CRAN,
24+
we will try to keep the package simple and stable, with infrequent
2125
updates. A development version will be available via the relevant github
2226
repository (see below).
2327
We do not intend to specify a GitHub remote so these updates will not be
@@ -26,7 +30,7 @@ intervenes.
2630

2731
## Installation
2832

29-
Install the released version of natcpp from [CRAN](https://CRAN.R-project.org) with:
33+
Install the released version of natcpp from [CRAN](https://cran.r-project.org/package=natcpp) with:
3034

3135
``` r
3236
install.packages("natcpp")
@@ -52,5 +56,3 @@ library(natcpp)
5256
topntail(as.seglist(Cell07PNs[[1]]))
5357

5458
```
55-
56-
.

0 commit comments

Comments
 (0)