diff options
author | Nick Gerace <nickagerace@gmail.com> | 2021-09-15 22:40:22 -0400 |
---|---|---|
committer | Nick Gerace <nickagerace@gmail.com> | 2021-09-15 22:48:20 -0400 |
commit | fc1c143e2d8f9d518ce3f479942b78939a99a9f2 (patch) | |
tree | 87d44d06c0cb72927569ee3bd70215f2a5fd17af /docs | |
parent | 6c3a22d302d9daea0b4f142facdd6afefdc8b95f (diff) | |
download | gfold-fc1c143e2d8f9d518ce3f479942b78939a99a9f2.zip |
Convert library-driven structure to application-driven
Convert library-driven structure to application-driven. Remove library.
Remove EXTRA and DEVELOPING files. Move remaining docs to root. Create
types file in favor of types within modules. Add tag workflow for
prereleases and releases without artifacts. Remove Config struct for
Driver.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/DEVELOPING.md | 23 | ||||
-rw-r--r-- | docs/EXTRA.md | 31 | ||||
-rw-r--r-- | docs/RELEASE.md | 49 | ||||
-rw-r--r-- | docs/THANKS.md | 5 |
4 files changed, 0 insertions, 108 deletions
diff --git a/docs/DEVELOPING.md b/docs/DEVELOPING.md deleted file mode 100644 index 9884d04..0000000 --- a/docs/DEVELOPING.md +++ /dev/null @@ -1,23 +0,0 @@ -# Developing - -This document contains all tips, tricks and notes related to developing `gfold`. - -## Building - -On a compatible platform, execute the following commands: - -```sh -TEMP_TARGET=$HOME -cargo update -cargo +nightly fmt -cargo clippy -cargo test -cargo build --release -TEMP_BINARY=target/release/gfold -du -h $TEMP_BINARY | cut -f -1 -strip $TEMP_BINARY -du -h $TEMP_BINARY | cut -f -1 -time $TEMP_BINARY $TEMP_TARGET -``` - -> You can change `TEMP_TARGET` to a directory you'd like to target.
\ No newline at end of file diff --git a/docs/EXTRA.md b/docs/EXTRA.md deleted file mode 100644 index 8076410..0000000 --- a/docs/EXTRA.md +++ /dev/null @@ -1,31 +0,0 @@ -# Extra - -This document contains extra information related to using `gfold`. - -## Post-Installation - -It is highly recommended to run `strip` against the binary on compatible systems to reduce executable size. - -```sh -( TEMP=$(command -v gfold); du -h $TEMP; strip $TEMP; du -h $TEMP ) -``` - -> The above script will exit with a non-zero exit code if `gfold` is not installed and/or is not in your `PATH`. - -## Automatic Upgrades with Cargo - -Keeping the crate up to date is easy with [cargo-update](https://crates.io/crates/cargo-update). - -```sh -cargo install cargo-update -cargo install-update -a -``` - -You can chain this together with the **Post-Installation** step for automatic upgrades. - -## Where is `gfld`? - -`gfld` was an experimental, minimal version of `gfold`. -It was intended to potentially replace `gfold`, but has since been removed. -All optimizations and lessons learned from the project have since been integrated into `gfold`. -Check out the [removal issue to learn more](https://github.com/nickgerace/gfold/issues/110). diff --git a/docs/RELEASE.md b/docs/RELEASE.md deleted file mode 100644 index c435d64..0000000 --- a/docs/RELEASE.md +++ /dev/null @@ -1,49 +0,0 @@ -# Release - -This document contains all information related to release. - -## Preparation - -- [ ] Change the `version` field in `Cargo.toml` to `<new-tag>` -- [ ] Run the commands and verify that everything looks/works as expected: - -```sh -cargo update -cargo +nightly fmt --all -- --check -cargo clippy -- -D warnings -cargo test -- --nocapture -cargo doc --open -cargo build --release -``` - -- [ ] Change the version in `CHANGELOG.md` and uncomment the line, `<!--The latest version contains all changes.-->`. -- [ ] Create a commit with the following message: `Update to <new-tag>`. Do not push (or merge) the commit. -- [ ] Test the publishing workflow: - -```sh -cargo publish --dry-run -``` - -- [ ] Finally, push (or merge) the preparation commit. - -## Tagging and Publishing - -- [ ] Once the prepation commit has been pushed (or merged) into `main`, execute the following commands: - -```sh -git tag <new-tag> -git push --tags origin main -``` - -- [ ] Now, publish the crate. - -```sh -cargo publish -``` - -- [ ] Check the [crate](https://crates.io/crates/gfold) on `crates.io`. -- [ ] Check the [docs](https://docs.rs/gfold) on `docs.rs`. - -## Updating the Homebrew Tap - -- [ ] Update the formula for the [tap](https://github.com/nickgerace/homebrew-gfold). diff --git a/docs/THANKS.md b/docs/THANKS.md deleted file mode 100644 index a710775..0000000 --- a/docs/THANKS.md +++ /dev/null @@ -1,5 +0,0 @@ -## Special Thanks - -- [@jrcichra](https://github.com/jrcichra) for adding multi-OS support to the original, early-stage CI pipeline -- [@orhun](https://github.com/orhun) for maintaining [all AUR packages](https://github.com/orhun/PKGBUILDs) -- [@yaahc](https://github.com/yaahc) for mentoring during an early refactor |