diff --git a/Makefile b/Makefile index 26079a2a..bc9d60fc 100644 --- a/Makefile +++ b/Makefile @@ -23,10 +23,12 @@ else # win32 DAEMON_SRC += DaemonWin32.cpp endif -all: mk_build_dir $(SHLIB) $(I2PD) $(TESTS) +all: mk_build_dir $(SHLIB) $(I2PD) +tests: mk_build_test_dir $(TESTS) mk_build_dir: mkdir -p obj +mk_build_test_dir: mkdir -p obj/tests api: $(SHLIB) @@ -74,8 +76,10 @@ dist: --prefix=i2pd_$(LATEST_TAG)/ $(LATEST_TAG) -o i2pd_$(LATEST_TAG).tar.gz .PHONY: all +.PHONY: tests .PHONY: clean .PHONY: deps .PHONY: dist .PHONY: api .PHONY: mk_build_dir +.PHONY: mk_build_test_dir diff --git a/README.md b/README.md index 8d181cf5..43dcaac5 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,18 @@ After that, go to the webconsole and add it behind the url. (Remove http:// from This should resulting in for example: http://localhost:7070/4oes3rlgrpbkmzv4lqcfili23h3cvpwslqcfjlk6vvguxyggspwa.b32.i2p +Building Unit Tests +------------------- + +To build unit tests, you'll need to install the boost unit test framework. + +On Ubuntu/Debian based + * sudo apt-get install libboost-test-dev + +To build the tests, run + +$ make tests + Cmdline options --------------- @@ -117,35 +129,35 @@ i2p.conf: tunnels.cfg (filename of this config is subject of change): - ; outgoing tunnel sample, to remote service - ; mandatory parameters: - ; * type -- always "client" - ; * port -- local port to listen to - ; * destination -- i2p hostname - ; optional parameters (may be omitted) - ; * keys -- our identity, if unset, will be generated on every startup, - ; if set and file missing, keys will be generated and placed to this file - ; * address -- address to listen on, 127.0.0.1 by default - [IRC] - type = client - port = 6668 - destination = irc.echelon.i2p - keys = irc-keys.dat - - ; incoming tunnel sample, for local service - ; mandatory parameters: - ; * type -- always "server" - ; * host -- ip address of our service - ; * port -- port of our service - ; * keys -- file with LeaseSet of address in i2p - ; optional parameters (may be omitted) - ; * inport -- optional, i2p service port, if unset - the same as 'port' - ; * accesslist -- comma-separated list of i2p addresses, allowed to connect - ; every address is b32 without '.b32.i2p' part - [LOCALSITE] - type = server - host = 127.0.0.1 - port = 80 - keys = site-keys.dat - inport = 81 - accesslist = [,] + ; outgoing tunnel sample, to remote service + ; mandatory parameters: + ; * type -- always "client" + ; * port -- local port to listen to + ; * destination -- i2p hostname + ; optional parameters (may be omitted) + ; * keys -- our identity, if unset, will be generated on every startup, + ; if set and file missing, keys will be generated and placed to this file + ; * address -- address to listen on, 127.0.0.1 by default + [IRC] + type = client + port = 6668 + destination = irc.echelon.i2p + keys = irc-keys.dat + + ; incoming tunnel sample, for local service + ; mandatory parameters: + ; * type -- always "server" + ; * host -- ip address of our service + ; * port -- port of our service + ; * keys -- file with LeaseSet of address in i2p + ; optional parameters (may be omitted) + ; * inport -- optional, i2p service port, if unset - the same as 'port' + ; * accesslist -- comma-separated list of i2p addresses, allowed to connect + ; every address is b32 without '.b32.i2p' part + [LOCALSITE] + type = server + host = 127.0.0.1 + port = 80 + keys = site-keys.dat + inport = 81 + accesslist = [,]