Skip to content

Commit

Permalink
Updated to reflect that we are now building with gradle.
Browse files Browse the repository at this point in the history
  • Loading branch information
adoble committed Feb 11, 2019
1 parent adedbf1 commit aca8db1
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

## Windows

1. Download the source code
2. Run `mvn install`
3. Set the environment variable `ADR_HOME` to the the directory containing the target
4. Set the environment variable `EDITOR` or `VISUAL` to the location of the editor you what to use for editing the ADRs (e.g. Atom)
5. Add `...\launch-scripts\adr.bat` to the `PATH` environment variable
1. Download the source code.
2. Make sure you have gradle installed (https://gradle.org/).
3. Run `gradlew releaseJar`. This should create a file `build/releases/adr-j.jar`.
4. Set the environment variable `ADR_HOME` to the folder where you downloaded the source code. This should contain the `build` folder.
5. Set the environment variable `EDITOR` or `VISUAL` to the location of the editor you what to use for editing the ADRs (e.g. Atom)
6. Add `%ADR_HOME%\launch-scripts\adr.bat` to the `PATH` environment variable

You should now be able to type `adr` from the command line and see a response.

0 comments on commit aca8db1

Please sign in to comment.