Skip to content

Commit

Permalink
Updated installation intructions for unix
Browse files Browse the repository at this point in the history
  • Loading branch information
adoble committed Mar 17, 2019
1 parent c28e955 commit c01d42a
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,16 @@ You should now be able to type `adr` from the command line and see a response.
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:
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.

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.

0 comments on commit c01d42a

Please sign in to comment.