diff options
author | Nick Gerace <nickagerace@gmail.com> | 2022-12-21 18:03:37 -0500 |
---|---|---|
committer | Nick Gerace <nickagerace@gmail.com> | 2022-12-21 18:22:35 -0500 |
commit | 5c297ada857562b30de3801b09fdbf697182eb76 (patch) | |
tree | 12f3fe6d641aea64cbe04fe88e8ef71f14f331aa /docs | |
parent | 687b3f50d359c4225a5b4e4085c43d693e8a12d4 (diff) | |
download | gfold-5c297ada857562b30de3801b09fdbf697182eb76.zip |
Add submodule support in json mode
Primary:
- Add submodule collection and support in json display mode
Doc:
- Ensure build from source instructions work with cargo workspaces
- Add "no deps" flag to clippy usages
Misc:
- Add result type aliases
- Change NOTE, FIXME, and TODO comments to have the author's nickname
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/DEVELOPING.md | 4 | ||||
-rw-r--r-- | docs/MANUAL_INSTALL.md | 12 | ||||
-rw-r--r-- | docs/RELEASE.md | 4 |
3 files changed, 12 insertions, 8 deletions
diff --git a/docs/DEVELOPING.md b/docs/DEVELOPING.md index d4ed78e..8402799 100644 --- a/docs/DEVELOPING.md +++ b/docs/DEVELOPING.md @@ -10,7 +10,7 @@ First, update dependencies and tidy your changes. cargo fmt cargo update cargo fix --edition-idioms --allow-dirty --allow-staged -cargo clippy --all-features --all-targets +cargo clippy --all-features --all-targets --no-deps ``` Now, ensure that lints, tests, and builds succeed. @@ -18,7 +18,7 @@ Now, ensure that lints, tests, and builds succeed. ```shell cargo fmt --all -- --check cargo clippy -- -D warnings -RUSTDOCFLAGS="-Dwarnings" cargo doc --all +RUSTDOCFLAGS="-Dwarnings" cargo doc --all --no-deps cargo test -- --nocapture cargo build --all-targets ``` diff --git a/docs/MANUAL_INSTALL.md b/docs/MANUAL_INSTALL.md index 02e7473..d89a074 100644 --- a/docs/MANUAL_INSTALL.md +++ b/docs/MANUAL_INSTALL.md @@ -78,12 +78,16 @@ rm /usr/local/bin/gfold rm $HOME/.config/gfold.toml ``` -## Build From Source Locally with Cargo +## Build From Source Locally On All Platforms If you want to install from source locally, and not from [crates.io](https://crates.io/crates/gfold), you can clone the repository and build `gfold`. This should work on all major platforms. -```shell +```bash git clone https://github.com/nickgerace/gfold.git -cargo install --path gfold -```
\ No newline at end of file +cd gfold; cargo install --path crates/gfold +``` + +The commands above were tested on macOS. +Slight modification may be required for your platform, but the flow should be the same: clone, change directory and run +`cargo install`.
\ No newline at end of file diff --git a/docs/RELEASE.md b/docs/RELEASE.md index b46ea97..4b87ee0 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -16,8 +16,8 @@ Steps should be executed in sequential order. cargo fmt --all -- --check cargo clippy -- -D warnings cargo test -RUSTDOCFLAGS="-Dwarnings" cargo doc --all -cargo build +RUSTDOCFLAGS="-Dwarnings" cargo doc --all --no-deps +cargo build --all-targets ``` - [ ] Create and _do not merge_ a commit with the following message: `Update to <tag>` |