Skip to content

Commit

Permalink
Updated README.md with build instructions and requirements.
Browse files Browse the repository at this point in the history
  • Loading branch information
J Ninja committed Jun 24, 2019
1 parent 351d28b commit e7fbd13
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

`iching` is an encoder/decoder based on the book *[I Ching](https://en.wikipedia.org/wiki/I_Ching)* which maps base64 values to *I Ching* hexagrams and decodes them using an efficient 2D trigram lookup table.

## Requirements

* CMake
* Boost >=1.66

## Building

```shell
$ mkdir build
$ cd build
$ cmake ..
$ make
```

## Usage

```bash
Expand Down

0 comments on commit e7fbd13

Please sign in to comment.