Skip to content

Clarify manual install path #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisNourse merged 2 commits into from
Jun 7, 2025
Merged

Clarify manual install path #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36ccdab
Clarify manual install path
ChrisNourse Jun 7, 2025
441008b
Fix bullet formatting
ChrisNourse Jun 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,11 @@ To conveniently run `dirdoc` from any folder on your system, choose one of the f

#### 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
Expand Down