Browse Source

Rewrite README.md from scratch

pull/1/head
heck 5 years ago
parent
commit
68a7e8f842
  1. 32
      README.md

32
README.md

@ -34,17 +34,12 @@ The default make target is `compile`.
* `make test` * `make test`
Builds the complete test-suite under `./test`. Builds the complete test-suite under `./test`.
### Clean ### Install
* `make clean` * `make install`
Deletes all the derived objects of the adapter build in `./build` and `./dist`. Installs the files under `./dist` under $PREFIX (local.conf)
Also invokes `make clean` which cleans the whole test-suite.
Does not remove the generated API doc.
* `make clean-doc`
Removes all the generated API doc.
* `make clean-all` * `make uninstall`
Equals `make clean` and `make clean-doc` Removes all the filenames under `./dist` from $PREFIX (local.conf)
### Doc ### Doc
In order to generate the API doc you need to have doxygen installed on your system. In order to generate the API doc you need to have doxygen installed on your system.
@ -58,9 +53,16 @@ In order to generate the API doc you need to have doxygen installed on your syst
* `make doc-java` * `make doc-java`
Generates the API doc for the Java part of the adapter. Generates the API doc for the Java part of the adapter.
### Install ### Clean
* `make install` * `make clean`
Installs the files under `./dist` under $PREFIX (local.conf) Deletes all the derived objects of the adapter build in `./build` and `./dist`.
Also invokes `make clean` which cleans the whole test-suite.
Does not remove the generated API doc.
* `make clean-doc`
Removes all the generated API doc.
* `make clean-all`
Equals `make clean` and `make clean-doc`
* `make uninstall`
Removes all the filenames under `./dist` from $PREFIX (local.conf)

Loading…
Cancel
Save