Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
foo-jin authored Nov 26, 2018
1 parent 139987d commit 3441931
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
# AoC-tools
This project is a simple toolset to retrieve [Advent of Code](https://adventofcode.com/) problem instances and submit solutions to them. I made this mainly for personal use, but feedback is always welcome.

## Installation
Clone the source repository, and then run `cargo install --path .`. This will use cargo to install the project in the current directory. The resulting binary will be placed in `$HOME/.cargo/bin` under default settings.

## Usage
If the binary is in PATH, you can run `aoc --help` for the usage instructions.

0 comments on commit 3441931

Please sign in to comment.