Skip to content
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.

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

Add coursier based installation instructions #565

Merged
merged 4 commits into from
May 28, 2021
Merged
Changes from 3 commits
Commits
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
28 changes: 13 additions & 15 deletions docs/01.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,25 @@ out: setup.html
Setup
-----

You can install Giter8 and other Scala command line tools with
[Conscript][cs]. This will setup Conscript in `~/.conscript/bin/cs`:
#### Coursier

curl https://raw.githubusercontent.com/foundweekends/conscript/master/setup.sh | sh
Giter8 and other Scala command line tools can be installed using [Coursier](https://get-coursier.io/).
See the coursier [installation instruction](https://get-coursier.io/docs/cli-installation) to add it to your path.
Once `cs` is on your path, you can install giter8 with this command:

(See [Conscript's readme][cs] for a non-unixy option.) Once `cs` is
on your path, you can install (or upgrade) giter8 with this command:
\$ cs install giter8

cs foundweekends/giter8
and update it using:

[cs]: http://www.foundweekends.org/conscript/setup.html
\$ cs update g8

To make sure everything is working, try running `g8` with no
parameters. This should download giter8 and its dependencies, then print
a usage message.
#### Manual

When it's time to upgrade to a new version of giter8, just run the
same `cs` command again.
It's possible to manually download and install giter8 directly from Maven Central:

Giter8 is also installable with the OS X package manager [Homebrew][]:
\$ curl https://repo1.maven.org/maven2/org/foundweekends/giter8/giter8-bootstrap_2.12/0.13.1/giter8-bootstrap_2.12-0.13.1.sh > ~/bin/g8
\$ chmod +x ~/bin/g8

\$ brew update && brew install giter8
Replace `~/bin/` with anything that is on your `PATH`. To make sure everything is working, try running `g8` with no
parameters,

[Homebrew]: https://brew.sh