Skip to content

Commit

Permalink
Add installation instructions for Mac and Ubuntu (#440)
Browse files Browse the repository at this point in the history
  • Loading branch information
vrom911 authored Mar 28, 2020
1 parent 754d460 commit e2bf2ca
Showing 1 changed file with 52 additions and 2 deletions.
54 changes: 52 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Or are you building a production application which uses a custom prelude and has
Maybe do you want to play with your idea in a single module without introducing the whole complexity of the Haskell projects?
Summoner can help you do all that with minimal effort from you - it can even upload the project to GitHub if you wish!

By the way, Summoner operates as either CLI or TUI application, so you can choose what you're more comfortable with and install only the required one.
By the way, Summoner operates as either CLI or TUI application, so you can choose what you are more comfortable with and install only the required one.

## Structure

Expand All @@ -33,10 +33,14 @@ By the way, Summoner operates as either CLI or TUI application, so you can choos
+ [Installation](#installation-)
+ [Summon-TUI](#summon-tui-)
+ [TUI: download binary](#tui-download-binary-)
+ [TUI: Homebrew](#tui-homebrew-)
+ [TUI: Ubuntu](#tui-ubuntu-)
+ [TUI: from Hackage/Stackage](#tui-from-hackagestackage-)
+ [TUI: from source](#tui-from-source-)
+ [Summon-CLI](#summon-cli-)
+ [CLI: download binary](#cli-download-binary-)
+ [CLI: Homebrew](#cli-homebrew-)
+ [CLI: Ubuntu](#cli-ubuntu-)
+ [CLI: from Hackage/Stackage](#cli-from-hackagestackage-)
+ [CLI: from source](#cli-from-source-)
+ [Setup](#setup-)
Expand Down Expand Up @@ -71,7 +75,7 @@ You can also see complete examples in the following folder:
The directory contains the following examples:

* [`cabal-minimal`](https://github.com/kowainik/summoner/tree/master/summoner-cli/examples/cabal-minimal):
minimal Haskell project with the Cabal-only support, default
Minimal Haskell project with the Cabal-only support, default
settings and all of the integrations disabled.
* [`cabal-full`](https://github.com/kowainik/summoner/tree/master/summoner-cli/examples/cabal-full):
Cabal-only project with all integrations enabled.
Expand Down Expand Up @@ -230,6 +234,29 @@ chmod +x summon-cli-linux
mv summon-cli-linux ~/.local/bin/summon
```

##### TUI: Homebrew [](#structure)

If you are on MacOS, you can get Summoner using Homebrew Kowainik's Tap.

You need to run the following commands for that:

```shell
$ brew tap kowainik/tap
$ brew install summoner-tui
```

##### TUI: Ubuntu [](#structure)

If you are on Ubuntu, you can get Summoner from Kowainik's PPA.

You need to run the following commands for that:

```shell
$ sudo add-apt-repository ppa:kowainik/summoner-tui
$ sudo apt update
$ sudo apt install summoner-tui
```

##### TUI: from Hackage/Stackage [](#structure)

Using `cabal`:
Expand Down Expand Up @@ -290,6 +317,29 @@ chmod +x summon-cli-linux
mv summon-cli-linux ~/.local/bin/summon
```

##### CLI: Homebrew [](#structure)

If you are on MacOS, you can get Summoner using Homebrew Kowainik's Tap.

You need to run the following commands for that:

```shell
$ brew tap kowainik/tap
$ brew install summoner-cli
```

##### CLI: Ubuntu [](#structure)

If you are on Ubuntu, you can get Summoner from Kowainik's PPA.

You need to run the following commands for that:

```shell
$ sudo add-apt-repository ppa:kowainik/summoner-cli
$ sudo apt update
$ sudo apt install summoner-cli
```

##### CLI: from Hackage/Stackage [](#structure)

Using `cabal`:
Expand Down

0 comments on commit e2bf2ca

Please sign in to comment.