Skip to content

Commit 6519e71

Browse files
authored
Update README.md: install instructions
1 parent 170fa9c commit 6519e71

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,8 +202,8 @@ Because it is a FAQ, the major differences between this project and uutils are:
202202
- [ ] uux (UUCP)
203203

204204
### Editors category
205-
- [ ] ed (Editors)
206-
- [ ] ex (Editors) -- Volunteer starting point at https://github.com/rustcoreutils/posixutils-rs/tree/ed
205+
- [ ] ed (Editors) -- Volunteer starting point at https://github.com/rustcoreutils/posixutils-rs/tree/ed
206+
- [ ] ex (Editors)
207207
- [ ] vi (Editors)
208208

209209
### Misc. category
@@ -220,6 +220,14 @@ Because it is a FAQ, the major differences between this project and uutils are:
220220
- [ ] talk (status: in progress)
221221
- [ ] timeout (status: in progress)
222222

223+
## Installation
224+
225+
These are "core" utilities of any operating system. Production packaging in the future will be done on a per-distro basis in a distro-specific way.
226+
227+
As such, Dockerfiles, rpm and deb packaging is welcome, but currently considered a secondary priority to finishing, bugfixing and tuning the utilities. Packaging contributions are weclome... if done right.
228+
229+
The standard `cargo install` should work, for those interested in testing. Care should be taken with PATH to point to the correct `cp` or `mv`, when mixing with standard system utilities on an already-shipped operating system.
230+
223231
## Testing
224232

225233
A few tests require additional setup such as a case-insensitive filesystem or the use of another command like [script](https://www.man7.org/linux/man-pages/man1/script.1.html). They are locked under the `posixutils_test_all` feature flag to exclude them from GitHub CI. These tests can be run by passing the feature flag to `cargo`:

0 commit comments

Comments
 (0)