Skip to content

Commit f139249

Browse files
committed
readme cleanups
1 parent 78353a4 commit f139249

File tree

2 files changed

+8
-22
lines changed

2 files changed

+8
-22
lines changed

README.Rmd

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ knitr::opts_chunk$set(
1717

1818
<!-- badges: start -->
1919

20-
[![nanonext status badge](https://shikokuchuo.r-universe.dev/badges/nanonext?color=112d4e)](https://shikokuchuo.r-universe.dev)
20+
[![nanonext status badge](https://shikokuchuo.r-universe.dev/badges/nanonext?color=3f72af)](https://shikokuchuo.r-universe.dev)
2121
[![R-CMD-check](https://github.com/shikokuchuo/nanonext/workflows/R-CMD-check/badge.svg)](https://github.com/shikokuchuo/nanonext/actions)
2222

2323
<!-- badges: end -->
@@ -111,20 +111,14 @@ This is available in system package repositories as:
111111
- `nng` (Homebrew on MacOS)
112112
- `nng` from vcpkg (see <https://vcpkg.io/>).
113113

114-
A system installation of 'libnng' in the standard filesystem locations will be detected and used. <sup>(1)</sup>
114+
A system installation of 'libnng' in the standard filesystem locations will be detected and used if possible.
115115

116-
Otherwise, a release version<sup>(2)</sup> of 'libnng'will be downloaded and built from source automatically during package installation (Note: this requires 'cmake' to be installed and on your $PATH).
116+
Otherwise, a release version of 'libnng' will be downloaded and built from source automatically during package installation (note: this requires 'cmake').
117117

118118
#### Windows
119119

120120
Pre-built libraries (for i386 / x64 / x64-UCRT) are automatically downloaded during the package installation process.
121121

122-
#### Notes
123-
124-
1. For building 'libnng' from source, ensure that 'cmake' uses the C compiler flag '-fPIC' by passing the option<br /> `-DCMAKE_C_FLAGS="${CMAKE_C_FLAGS} -fPIC"` if required.
125-
126-
2. Latest source releases: <https://github.com/nanomsg/nng/releases>
127-
128122
### Upstream
129123

130124
- NNG: <https://nng.nanomsg.org/>

README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<!-- badges: start -->
77

88
[![nanonext status
9-
badge](https://shikokuchuo.r-universe.dev/badges/nanonext?color=112d4e)](https://shikokuchuo.r-universe.dev)
9+
badge](https://shikokuchuo.r-universe.dev/badges/nanonext?color=3f72af)](https://shikokuchuo.r-universe.dev)
1010
[![R-CMD-check](https://github.com/shikokuchuo/nanonext/workflows/R-CMD-check/badge.svg)](https://github.com/shikokuchuo/nanonext/actions)
1111

1212
<!-- badges: end -->
@@ -143,25 +143,17 @@ This is available in system package repositories as:
143143
- `nng` from vcpkg (see <https://vcpkg.io/>).
144144

145145
A system installation of ‘libnng’ in the standard filesystem locations
146-
will be detected and used. <sup>(1)</sup>
146+
will be detected and used if possible.
147147

148-
Otherwise, a release version<sup>(2)</sup> of ‘libnng’will be downloaded
149-
and built from source automatically during package installation (Note:
150-
this requires cmake’ to be installed and on your $PATH).
148+
Otherwise, a release version of ‘libnng’ will be downloaded and built
149+
from source automatically during package installation (note: this
150+
requires cmake’).
151151

152152
#### Windows
153153

154154
Pre-built libraries (for i386 / x64 / x64-UCRT) are automatically
155155
downloaded during the package installation process.
156156

157-
#### Notes
158-
159-
1. For building ‘libnng’ from source, ensure that ‘cmake’ uses the C
160-
compiler flag ‘-fPIC’ by passing the option<br />
161-
`-DCMAKE_C_FLAGS="${CMAKE_C_FLAGS} -fPIC"` if required.
162-
163-
2. Latest source releases: <https://github.com/nanomsg/nng/releases>
164-
165157
### Upstream
166158

167159
- NNG: <https://nng.nanomsg.org/>

0 commit comments

Comments
 (0)