Skip to content

Commit

Permalink
Merge pull request #1 from chrovis/feature/update-readme
Browse files Browse the repository at this point in the history
Write how to install with Homebrew and add change log
  • Loading branch information
alumi authored Mar 15, 2024
2 parents 4c724a7 + b5ed22c commit 16427e0
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## [0.1.3] - 2024-03-13

The first release

[unreleased]: https://github.com/chrovis/gnife/compare/0.1.3...HEAD
[0.1.3]: https://github.com/chrovis/gnife/releases/tag/0.1.3
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,26 @@ Gnife is a CLI tool for manipulating genomic files and data.

## Installation

### Manual Install

Gnife requires you have installed Java. A binary are available on the
[releases](https://github.com/chrovis/gnife/releases) page.

```sh
curl -sSL https://github.com/chrovis/gnife/releases/download/0.1.3/gnife -o gnife
chmod +x gnife
mv gnife [/your/PATH/dir/]
```

## Build
### Homebrew

You can use [Homebrew](https://brew.sh/) on MacOS.

```sh
brew install xcoo/formulae/gnife
```

### Build

To build Gnife manually, you must setup Clojure (and Java) in advance.

Expand Down

0 comments on commit 16427e0

Please sign in to comment.