Skip to content

Commit 15bd6ab

Browse files
committed
Update README
1 parent a0abd89 commit 15bd6ab

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,27 @@ Foreman is inspired by [rustup](https://rustup.rs) and [asdf](https://github.com
66
It's an early prototype, but feedback at this stage is welcome!
77

88
## Installation
9+
10+
### GitHub Releases
911
You can download pre-built Foreman releases for Windows, macOS, and Linux from the [Releases](https://github.com/rojo-rbx/foreman/releases) page.
1012

11-
Alternatively, you can install from the `master` branch if you have [Rust](https://www.rust-lang.org/) 1.41.0 or newer installed:
13+
### GitHub Actions
14+
You can use the official [setup-foreman](https://github.com/rojo-rbx/setup-foreman) action to install Foreman as part of your GitHub Actions workflow.
15+
16+
### From Source
17+
If you have [Rust](https://www.rust-lang.org/) 1.41.0 or newer installed, you can also compile Foreman directly from Git yourself:
1218

1319
```bash
1420
cargo install --git https://github.com/rojo-rbx/foreman.git
1521
```
1622

17-
On first run (try `foreman list`), Foreman will create a `.foreman` directory in your user folder (`~/.foreman` on Unix systems, `%USERPROFILE%/.foreman` on Windows).
18-
19-
It's recommended that you **add `~/.foreman/bin` to your `PATH`** to make the tools that Foreman installs for you accessible on your system.
20-
2123
## Usage
2224
Foreman downloads tools from GitHub and references them by their `user/repo` name, like `rojo-rbx/foreman`.
2325

26+
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).
27+
28+
It's recommended that you **add `~/.foreman/bin` to your `PATH`** to make the tools that Foreman installs for you accessible on your system.
29+
2430
### System Tools
2531
To start using Foreman to manage your system's default tools, create the file `~/.foreman/foreman.toml`.
2632

@@ -52,7 +58,7 @@ When inside this directory, the `remodel` command will run the latest 0.6.x rele
5258
### Authentication
5359
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).
5460

55-
Open `~/.foreman/auth.toml` after Foreman has run at least once to see instructions on how to set this up.
61+
Use `foreman github-auth` to pass an authentication token to Foreman, or open `~/.foreman/auth.toml` and follow the contained instructions.
5662

5763
## Troubleshooting
5864
Foreman is a work in progress tool and has some known issues. Check out [the issue tracker](https://github.com/rojo-rbx/foreman/issues) for known bugs.

0 commit comments

Comments
 (0)