Skip to content

Missing critical onboarding info #107

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

Open
RandyGaul wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Missing critical onboarding info #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To upgrade, re-run `cargo install foreman` and clean up the `bin` directory as d
Most users will want to do a bit of additional setup to begin using tools via foreman.

### Path Configuration
On first run (try `foreman list`), Foreman will create a `.foreman` directory in your user folder (usually `$HOME/.foreman` on Unix systems, `%USERPROFILE%/.foreman` on Windows).
On first run (try `foreman list`), Foreman will create a `.foreman` directory in your user folder (usually `$HOME/.foreman` on Unix systems, `%USERPROFILE%\.foreman` on Windows).

It's recommended that you **add `$HOME/.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 `$HOME/.foreman/bin` is on your PATH _before_ any other installation directories like `.cargo/bin` in order to make sure it takes precedence.

Expand All @@ -48,7 +48,7 @@ export PATH=$HOME/.foreman/bin:$PATH
### Authentication
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). When creating the token in GitHub:

1. Make sure to create a `Tokens (classic)` Personal Access Token. Fine-grained tokens may not work properly.
1. Make sure to create a `Tokens (classic)` Personal Access Token. Fine-grained tokens may not work properly. Make sure to use your github.com profile and *not* your enterprise profile at github.rbx.com, otherwise the 3rd step below (Configure SSO) will not be available.
2. Make sure to configure the token to have access to the `repo` scope.
3. Once created, you may need to click the `Configure SSO` button next to the token to authorize it for SSO usage. Whether or not you need to do this will depend on the GitHub org that you need to access.

Expand Down