Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

Commit

Permalink
Docs: update build instructions for make install-resources
Browse files Browse the repository at this point in the history
* References #45
  • Loading branch information
anonimal committed Jul 20, 2016
1 parent 37c1cfd commit a96ac2b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
4. Download, build, and run:
```bash
$ git clone https://github.com/monero-project/kovri
$ make # or make -j [available CPU cores]
$ ./build/kovri -p [your chosen port number]
$ make && make install-resources # to decrease build-time, run make -j [available CPU cores]
$ ./build/kovri -p [your chosen port number] # port number without brackets
```
- For quick help options: ```$ ./kovri --help```
- For a detailed listing of options: ```$ ./kovri --help-with all```
Expand Down
8 changes: 8 additions & 0 deletions doc/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,10 @@ $ brew install miniupnpc doxygen # optional
```

## Step 3. Build
Note: you must **alway** run ```make install-resources``` for new installations

* ```make``` produces vanilla binary
* ```make install-resources``` installs resources (configuration files, certificates)
* ```make static``` produces static binary
* ```make upnp``` produces vanilla binary with UPnP support (requires [MiniUPnP](http://miniupnp.free.fr/files/))
* ```make tests``` produces all unit-tests and benchmarks
Expand All @@ -68,6 +70,12 @@ $ export CC=clang CXX=clang++ && make # CC is optional to avoid CMake warnings

Replace ```clang``` with a clang version/path of your choosing.

### Custom data path
You can customize Kovri's data path to your liking. Simply export ```KOVRI_DATA_PATH```; example:

```bash
$ export KOVRI_DATA_PATH=$HOME/.another-kovri-data-path && make && make install-resources
```

## Step 4. Open your NAT/Firewall
1. Choose a port between ```9111``` and ```30777```
Expand Down

0 comments on commit a96ac2b

Please sign in to comment.