From 36ccdab690026f28dc472edcf06c2d7147d492c6 Mon Sep 17 00:00:00 2001 From: ChrisNo Date: Sat, 7 Jun 2025 15:43:07 -0700 Subject: [PATCH 1/2] Clarify manual install path --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 35613d2..3acf1f5 100644 --- a/README.md +++ b/README.md @@ -116,11 +116,13 @@ Visit the [GitHub Releases](https://github.com/ChrisNourse/dirdoc/releases) page To conveniently run `dirdoc` from any folder on your system, choose one of the following methods: -#### On Linux and macOS +-#### On Linux and macOS -- **Option 1:** Copy the binary to a directory in your PATH (e.g., `/usr/local/bin`): +- **Option 1:** Copy the compiled binary to a directory in your PATH (e.g., `/usr/local/bin`). + Ensure you have either run `make` (which places the binary in `build/dirdoc`) or downloaded the + release file and are currently in the folder that contains the `dirdoc` executable: ```bash - sudo cp dirdoc /usr/local/bin/dirdoc + sudo cp build/dirdoc /usr/local/bin/dirdoc # adjust the path if your binary is elsewhere ``` - **Option 2:** Add the folder containing `dirdoc` to your PATH. For example, if you place it in `~/dirdoc`, add the following to your `~/.bashrc` or `~/.bash_profile`: ```bash From 441008b5dadc0e24a18006703db56d2c6f87067e Mon Sep 17 00:00:00 2001 From: ChrisNo Date: Sat, 7 Jun 2025 15:48:57 -0700 Subject: [PATCH 2/2] Fix bullet formatting --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3acf1f5..ab39360 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Visit the [GitHub Releases](https://github.com/ChrisNourse/dirdoc/releases) page To conveniently run `dirdoc` from any folder on your system, choose one of the following methods: --#### On Linux and macOS +#### On Linux and macOS - **Option 1:** Copy the compiled binary to a directory in your PATH (e.g., `/usr/local/bin`). Ensure you have either run `make` (which places the binary in `build/dirdoc`) or downloaded the