@@ -33,7 +33,7 @@ The minimum rust version required, by version:
3333This is tested in CI and must pass.
3434
3535# Test Matrix
36- The Github Actions CI test ` libproc-rs ` on :
36+ The GitHub Actions CI test ` libproc-rs ` on :
3737
3838rust versions:
3939* ` stable ` (must pass)
@@ -50,11 +50,11 @@ on the following platforms:
5050# Examples
5151Two simple examples are included to show libproc-rs working.
5252
53- - ` procinfo ` that takes a PID as an optional argument (uses it's own pid if none supplied) and returns
53+ - ` procinfo ` that takes a PID as an optional argument (uses its own pid if none supplied) and returns
5454 information about the process on stdout
5555- ` dmesg ` is a version of dmesg implemented in rust that uses libproc-rs.
5656
57- These can be ran thus:
57+ These can be run thus:
5858` sudo cargo run --example procinfo ` or
5959` sudo cargo run --example dmesg `
6060
@@ -75,7 +75,7 @@ This project is in Drips [here](https://www.drips.network/app/projects/github/an
7575See the [ list of issues] ( https://github.com/andrewdavidmackenzie/libproc-rs/issues ) .
7676I put the "help wanted" label where I need help from others.
7777
78- - Look at what similar methods could be implemented as a starting poon Linux
78+ - Look at what similar methods could be implemented on Linux
7979- Complete the API on Mac OS X - figuring out all the Mac OS X / Darwin version mess....
8080- Add more documentation (including samples with documentation test)
8181- Add own custom error type and implement From::from to ease reporting of multiple error types in clients
@@ -96,8 +96,8 @@ In order to have tests pass when run as `root` or not, some tests need to check
9696at run-time (using our own ` am_root() ` function is handy) and avoid failing if * not* run as ` root ` .
9797
9898### Using ` act ` to run GH Actions locally
99- If you develop on macos but want to ensure code builds and tests pass on linux while making changes,
100- you can use the [ act] ( https://github.com/nektos/act ) tool to run the Github Actions Workflows on
99+ If you develop on macOS but want to ensure code builds and tests pass on linux while making changes,
100+ you can use the [ act] ( https://github.com/nektos/act ) tool to run the GitHub Actions Workflows on
101101the test matrix.
102102
103103Just install ` act ` (` brew install act ` on macOS) (previously install docker if you don't have it already,
@@ -106,14 +106,14 @@ and os versions of the matrix with something like `act push --matrix os:ubuntu-l
106106
107107## Enter the matrix
108108If you want to test locally as much of the test matrix as possible (different OS and
109- versions of rust), that you can use ` make matrix ` . On macos , if you have ` act `
109+ versions of rust), that you can use ` make matrix ` . On macOS , if you have ` act `
110110installed, it will use it to run the linux part of the matrix.
111111
112- ### Macos : clang detection and header file finding
113- Newer versions of ` bindgen ` have improved the detection of ` clang ` and hence macos header files.
112+ ### macOS : clang detection and header file finding
113+ Newer versions of ` bindgen ` have improved the detection of ` clang ` and hence macOS header files.
114114If you also have llvm/clang installed directly or via ` brew ` this may cause the build to fail saying it
115115cannot find ` libproc.h ` . This can be fixed by setting ` CLANG_PATH="/usr/bin/clang" ` so that ` bindgen `
116- detects the Xcode version and hence can fidn the correct header files.
116+ detects the Xcode version and hence can find the correct header files.
117117
118118# Other docs
119119* [ Reference docs] ( doc/References.md ) used to build and document libproc-rs
0 commit comments