Skip to content

Commit 762a963

Browse files
Update README.md (#50)
Minor improvements to docs that should help prevent folks from missing things. A bit of elaboration of a known pitfall with adding foreman binaries to the PATH when other installations are ahead of them.
1 parent 75bea11 commit 762a963

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,23 @@ cargo install foreman
3232

3333
To upgrade, re-run `cargo install foreman` and clean up the `bin` directory as described in the section just above.
3434

35-
## Usage
36-
Foreman downloads tools from GitHub or GitLab and references them by their `user/repo` name, like `Roblox/foreman`.
35+
## Setup
36+
Most users will want to do a bit of additional setup to begin using tools via foreman.
3737

38+
### Path Configuration
3839
On first run (try `foreman list`), Foreman will create a `.foreman` directory in your user folder (usually `~/.foreman` on Unix systems, `%USERPROFILE%/.foreman` on Windows).
3940

40-
It's recommended that you **add `~/.foreman/bin` to your `PATH`** to make the tools that Foreman installs for you accessible on your system.
41+
It's recommended that you **add `~/.foreman/bin` to your `PATH`** to make the tools that Foreman installs for you accessible on your system. If you have tools installed via other mechanisms (for example, you may have previously installed `rojo` directly via `cargo`), ensure that `~/.foreman/bin` is on your PATH _before_ any other installation directories like `.cargo/bin` in order to make sure it takes precedence.
42+
43+
### Authentication
44+
To install tools from a private GitHub repository, Foreman supports authenticating with a [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
45+
46+
Use `foreman github-auth` to pass an authentication token to Foreman, or open `~/.foreman/auth.toml` and follow the contained instructions.
47+
48+
Similarly, for projects hosted on a GitLab repository, use `foreman gitlab-auth` to pass an authentication token to Foreman, or open `~/.foreman/auth.toml`.
49+
50+
## Usage
51+
Foreman downloads tools from GitHub or GitLab and references them by their `user/repo` name, like `Roblox/foreman`.
4152

4253
### Configuration File
4354

@@ -81,13 +92,6 @@ Run `foreman install` to tell Foreman to install any new binaries from this conf
8192

8293
When inside this directory, the `remodel` command will run the latest 0.6.x release of Remodel installed on your system.
8394

84-
### Authentication
85-
To install tools from a private GitHub repository, Foreman supports authenticating with a [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
86-
87-
Use `foreman github-auth` to pass an authentication token to Foreman, or open `~/.foreman/auth.toml` and follow the contained instructions.
88-
89-
Similarly, for projects hosted on a GitLab repository, use `foreman gitlab-auth` to pass an authentication token to Foreman, or open `~/.foreman/auth.toml`.
90-
9195
## Troubleshooting
9296
Foreman is a work in progress tool and has some known issues. Check out [the issue tracker](https://github.com/Roblox/foreman/issues) for known bugs.
9397

0 commit comments

Comments
 (0)