INSTALL.md

Install ADR-J

Windows

1. Download the source code.

2. Make sure you have Java version 17 or higher installed.

3. Make sure you have Gradle installed (https://gradle.org/).

4. Run gradlew releaseJar. This should create a file build/releases/adr-j.jar.

5. Set the environment variable ADR_HOME to the folder where you downloaded the source code. This should contain the build folder.

6. Set the environment variable ADR_EDITOR or ADR_VISUAL to the location of the editor you what to use for editing the ADRs (e.g. Atom). If none of those variables set, ADR will use EDITOR and VISUAL variables. If the path to the editor has spaces in it, do not use quotes in the enviroment variable, e.g. instead of ...\Programs\"Microsoft VS Code"\bin\code.cmd use instead ...\Programs\Microsoft VS Code\bin\code.cmd.

7. Add %ADR_HOME%\launch-scripts to the PATH environment variable

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

Unix

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. For instance this could be done by using the adding the following to the ~/.bashrc file:

# For example
export ADR_HOME=~/adr-j

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), e.g. in the ~/.bashrc file:

# For example
export EDITOR=/usr/bin/vi

6. Move %ADR_HOME%\launch-scripts\adr to the ~/bin directory.

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

Of course, there are many other ways to install adr-j on unix depending on your personal preferences; important is that the environment variables are set.