Skip to content

Tweak README and add information on AUR availability #62

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

Merged
merged 2 commits into from
Apr 28, 2021
Merged

Tweak README and add information on AUR availability #62

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41cc506
Rename 'Running' to 'Installation and Usage'
Maxr1998 Apr 2, 2021
650dbcf
Add information on AUR availability
Maxr1998 Apr 2, 2021
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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,17 @@ The Apache Spark adaptation of it is located in a separate [repository](https://

The previous version of the Sparklin is accessible in the `sparklin` branch.

## Running
## Installation and Usage

You can download archive from Maven Central:
1. Go to https://search.maven.org/artifact/org.jetbrains.kotlinx/ki-shell
2. Select latest (or desired) version there (currently it's [0.3.2](https://search.maven.org/remotecontent?filepath=org/jetbrains/kotlinx/ki-shell/0.3.2/ki-shell-0.3.2-archive.zip))
3. Unpack it to desired place
4. Launch `bin/ki.sh` for Linux/Mac or `bin\ki.bat` for Windows

On Arch Linux, there's an [AUR package](https://aur.archlinux.org/packages/ki-shell-bin/) available.
After installation, you can run the shell through `ki`.

## Build From Source

To build from source use:
Expand Down