summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2021-06-17 22:49:47 -0400
committerNick Gerace <nickagerace@gmail.com>2021-06-17 22:58:48 -0400
commit72ea1b30a33bceaaf3a27895e67adaa80096be33 (patch)
tree5e8a10f59bae81a8c6d616eed922f075b4bac4c4
parentc3aef2868718e34d1d8f43af4ffa530a520a9a2d (diff)
downloadgfold-72ea1b30a33bceaaf3a27895e67adaa80096be33.zip
Move docs to their own directory and simplify README
-rw-r--r--CHANGELOG.md5
-rw-r--r--README.md51
-rw-r--r--docs/ADVANCED.md31
-rw-r--r--docs/DEVELOPING.md (renamed from DEVELOPING.md)9
-rw-r--r--docs/RELEASE.md (renamed from RELEASE.md)0
5 files changed, 56 insertions, 40 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5f5fa84..57c8cd9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,8 +6,11 @@ All changes are from [@nickgerace](https://github.com/nickgerace) unless otherwi
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
+<!-- The latest version contains all changes. -->
-The latest version contains all changes.
+### Changed
+
+- Documentation to be moved to the new `docs` directory
## [1.3.0] - 2021-05-25
diff --git a/README.md b/README.md
index 5a56198..d877adf 100644
--- a/README.md
+++ b/README.md
@@ -29,13 +29,23 @@ However, if you would like to target another directory, you can pass that path (
## Installation
-**You can use [macOS Homebrew](https://brew.sh) or [Linuxbrew](https://docs.brew.sh/Homebrew-on-Linux)** to install the [tap](https://github.com/nickgerace/homebrew-gfold).
+There multiple methods for installing `gfold`.
+
+### Homebrew and Linux Brew
+
+You can use [macOS Homebrew](https://brew.sh) or [Linuxbrew](https://docs.brew.sh/Homebrew-on-Linux) to install the [tap](https://github.com/nickgerace/homebrew-gfold).
```sh
-brew install nickgerace/gfold/gfold
+brew install nickgerace/gfold/gfold`
```
-**You can use a Linux distribution that supports installing packages from the AUR** to install: [gfold](https://aur.archlinux.org/packages/gfold/) (builds from source) and/or [gfold-git](https://aur.archlinux.org/packages/gfold-git/) (VCS/development package).
+### AUR
+
+You can use a Linux distribution that supports installing packages from the AUR, [Arch User Respository](https://aur.archlinux.org/), to install the following:
+
+- [gfold](https://aur.archlinux.org/packages/gfold/) - builds from source
+- [gfold-git](https://aur.archlinux.org/packages/gfold-git/) - development package
+
Many people choose to use an [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers), such as [yay](https://github.com/Jguer/yay) or [paru](https://github.com/Morganamilo/paru), in order to install their AUR packages.
```sh
@@ -43,29 +53,14 @@ yay -S gfold
paru -S gfold
```
-**You can use [cargo](https://crates.io)** to install the [crate](https://crates.io/crates/gfold) on almost any platform.
-
-```sh
-cargo install gfold
-```
-
-> 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
-> ```
-
-### Post-Installation
+### Cargo
-It is highly recommended to run `strip` against the binary on compatible systems to reduce executable size.
+You can use [cargo](https://crates.io) to install the [crate](https://crates.io/crates/gfold) on almost any platform.
```sh
-TEMP=$(command -v gfold) && du -h $TEMP && strip $TEMP && du -h $TEMP
+cargo install gfold
```
-> The above script will exit with a non-zero exit code if `gfold` is not installed and/or is not in your `PATH`.
-
## Usage
Pass in the `-h`, or `--help`, flag to see all the options for using this application.
@@ -83,24 +78,10 @@ gfold ../../this/is/a/relative/path
`gfold` is intended to be ran on *any* tier one Rust target.
Please [file an issue](https://github.com/nickgerace/gfold/issues) if your platform is unsupported.
-## 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).
-
-## Other Documentation
-
-- **[CHANGELOG.md](./CHANGELOG.md):** follows the [Keep a Changelog](https://keepachangelog.com/) format
-- **[DEVELOPING.md](./DEVELOPING.md):** developer tips, tricks, and notes
-- **[RELEASE.md](./RELEASE.md):** release process notes
-
## Code of Conduct
This repository follows and enforces the Rust programming language's [Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct).
-
## Maintainers
- [@nickgerace](https://nickgerace.dev)
diff --git a/docs/ADVANCED.md b/docs/ADVANCED.md
new file mode 100644
index 0000000..b136801
--- /dev/null
+++ b/docs/ADVANCED.md
@@ -0,0 +1,31 @@
+# Advanced Usage
+
+This document contains recommendations for experienced terminal users and/or frequent `gfold` users.
+
+## 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). \ No newline at end of file
diff --git a/DEVELOPING.md b/docs/DEVELOPING.md
index c2bdcf2..9884d04 100644
--- a/DEVELOPING.md
+++ b/docs/DEVELOPING.md
@@ -13,10 +13,11 @@ cargo +nightly fmt
cargo clippy
cargo test
cargo build --release
-du -h target/release/gfold | cut -f -1
-strip target/release/gfold
-du -h target/release/gfold | cut -f -1
-time target/release/gfold $TEMP_TARGET
+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/RELEASE.md b/docs/RELEASE.md
index c435d64..c435d64 100644
--- a/RELEASE.md
+++ b/docs/RELEASE.md