Skip to content

Commit 225a070

Browse files
committed
Release 0.5.0
1 parent a57ba51 commit 225a070

File tree

4 files changed

+20
-10
lines changed

4 files changed

+20
-10
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Foreman Changelog
2+
3+
## 0.5.0
4+
- Initial release
5+
- Version number chosen so that Foreman can take over the [foreman](https://crates.io/crates/foreman) crate on crates.io and leave existing versions alone.

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22
name = "foreman"
33
description = "Toolchain manager for simple binary tools"
4-
version = "0.1.0"
4+
version = "0.5.0"
55
authors = ["Lucien Greathouse <[email protected]>"]
66
license = "MIT"
77
homepage = "https://github.com/rojo-rbx/foreman#readme"

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,24 @@ Foreman is inspired by [rustup](https://rustup.rs) and [asdf](https://github.com
55

66
It's an early prototype, but feedback at this stage is welcome!
77

8-
## Setup
9-
You'll need to build from source for now. Foreman builds on the latest stable version of Rust, currently 1.41.0.
8+
## Installation
9+
You can download pre-built Foreman releases for Windows, macOS, and Linux from the [Releases](https://github.com/rojo-rbx/foreman/releases) page.
1010

11-
To install from the master branch, use:
11+
Alternatively, you can install from the `master` branch if you have [Rust](https://www.rust-lang.org/) 1.41.0 or newer installed:
1212

1313
```bash
1414
cargo install --git https://github.com/rojo-rbx/foreman.git
1515
```
1616

1717
On first run (try `foreman list`), Foreman will create a `.foreman` directory in your user folder (`~/.foreman` on Unix systems, `%USERPROFILE%/.foreman` on Windows).
1818

19-
It's recommended that you add `~/.foreman/bin` to your `PATH`.
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.
2020

2121
## Usage
2222
Foreman downloads tools from GitHub and references them by their `user/repo` name, like `rojo-rbx/foreman`.
2323

2424
### System Tools
25-
To start using Foreman to manage your system's default tools, which will be used unless a project overrides them, create the file `~/.foreman/foreman.toml`.
25+
To start using Foreman to manage your system's default tools, create the file `~/.foreman/foreman.toml`.
2626

2727
A Foreman config that lists Rojo could look like:
2828

@@ -31,7 +31,7 @@ A Foreman config that lists Rojo could look like:
3131
rojo = { source = "rojo-rbx/rojo", version = "0.5.0" }
3232
```
3333

34-
Run `foreman install` from any directory to have Foreman pick up and install any tools listed in your system's Foreman config.
34+
Run `foreman install` from any directory to have Foreman pick up and install the tools listed in your system's Foreman config.
3535

3636
Now, if you run `rojo` inside of a directory that doesn't specify its own version of Rojo, Foreman will run the most recent 0.5.x release for you!
3737

@@ -49,10 +49,15 @@ Run `foreman install` to tell Foreman to install any new binaries from this conf
4949

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

52+
### Authentication
53+
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).
54+
55+
Open `~/.foreman/auth.toml` after Foreman has run at least once to see instructions on how to set this up.
56+
5257
## Troubleshooting
53-
Foreman is a super early tool and has problems. Check out [the issue tracker](https://github.com/rojo-rbx/foreman/issues) for known bugs.
58+
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.
5459

55-
If you have issues with configuration, try deleting `~/.foreman` to start from scratch. This directory contains all of Foreman's installed tools and configuration.
60+
If you have issues with configuration, you can delete `~/.foreman` to delete all cached data and start from scratch. This directory contains all of Foreman's installed tools and configuration.
5661

5762
## License
5863
Foreman is available under the MIT license. See [LICENSE.txt](LICENSE.txt) or <https://opensource.org/licenses/MIT> for details.

0 commit comments

Comments
 (0)