diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..37828ae --- /dev/null +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index 1cd66f4..9f81017 100644 --- a/README.md +++ b/README.md @@ -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.