summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2022-03-10 09:11:55 -0700
committerNick Gerace <nickagerace@gmail.com>2022-03-10 11:24:30 -0500
commit46d9b240e774432e6261d311f3ae313d2ab2d6c2 (patch)
treee068bcbbbc3a214c1fbc70a6edcf8ec4e488be9d
parent3a3ff19502b41f73ac151689acd386a16ee24128 (diff)
downloadgfold-46d9b240e774432e6261d311f3ae313d2ab2d6c2.zip
Add README notice for version 4.0.0
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
-rw-r--r--README.md11
-rw-r--r--src/cli.rs4
2 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index f19bf10..2e19c6d 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,11 @@
[![arch linux](https://img.shields.io/archlinux/v/community/x86_64/gfold?logo=archlinux&logoColor=white&style=flat-square&color=blue)](https://archlinux.org/packages/community/x86_64/gfold/)
[![license](https://img.shields.io/github/license/nickgerace/gfold?style=flat-square&logo=apache&color=silver)](./LICENSE)
+> This **README** is for users building from `main` in anticipation of `gfold 4.0.0`.
+> Since `gfold 4.0.0` has not yet been released, contents of this **README** may be inapplicable to your version of `gfold`.
+>
+> For the latest, full release (`gfold 3.0.0`), please refer to the [**README** most closely corresponding to it (`92e976b207`)](https://github.com/nickgerace/gfold/blob/92e976b207d7c1074bb87432e0e6ca3cd6575cf3/README.md).
+
`gfold` is a CLI-driven application that helps you keep track of multiple Git repositories.
```
@@ -42,6 +47,12 @@ prime clean issue2287 git@github.com:bos/prime.git
If you'd prefer to use the classic display mode by default, and avoid setting the flag every time, you can set it in the config file (see **Usage** section).
+## Upcoming Release
+
+The next version of `gfold` will be `gfold 4.0.0`.
+While it might seem odd to bump the major version field so soon, user feedback and feature requests have been front and center for the next release, and setting up `gfold` for the future requires bumping that field.
+This **README** reflects changes in between the latest release (`gfold 3.0.0`) and the next release (`gfold 4.0.0`).
+
## Description
This app displays relevant information for multiple Git repositories in one to many directories.
diff --git a/src/cli.rs b/src/cli.rs
index 363bac4..a80fdaa 100644
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -15,8 +15,8 @@ While CLI options are prioritized, default options will fallback to the config
file if it exists. Here is the config file lookup locations for some common
operating systems:
- macOS/linux $HOME/.config/gfold/gfold.json
- windows {{FOLDERID_Profile}}\\.config\\gfold\\gfold.json")]
+ macOS/Linux $HOME/.config/gfold/gfold.json
+ Windows {{FOLDERID_Profile}}\\.config\\gfold\\gfold.json")]
struct Args {
#[argh(
positional,