You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,12 +32,23 @@ cargo install foreman
32
32
33
33
To upgrade, re-run `cargo install foreman` and clean up the `bin` directory as described in the section just above.
34
34
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.
37
37
38
+
### Path Configuration
38
39
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).
39
40
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`.
41
52
42
53
### Configuration File
43
54
@@ -81,13 +92,6 @@ Run `foreman install` to tell Foreman to install any new binaries from this conf
81
92
82
93
When inside this directory, the `remodel` command will run the latest 0.6.x release of Remodel installed on your system.
83
94
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
-
91
95
## Troubleshooting
92
96
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.
0 commit comments