King_DuckZ/orotool
1
0
Fork 0
Code Issues 3 Pull requests Releases Wiki Activity

More readme

Browse source
This commit is contained in:
King_DuckZ 2020-09-15 01:35:16 +02:00
parent 2534e5896c
commit 7d1011405a
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -74,6 +74,36 @@ Details about supported options:
* `rest_lib` which method will be used to access the remote API. `nap` is the internal one (curl+simdjson). `restc-cpp` is currently broken due to a [bug](https://github.com/jgaa/restc-cpp/issues/101) upstream
* `with_lzma` adds support for JSON logs compression (option `json_store_mode=xz` in the config file)
### Debug build ###
If you want to work on orotool I suggest the following configuration (assuming ~/dev/orotool is where the source code is):
```
meson setup -Dbase_url=http://localhost:8080 --sysconfdir ~/dev/orotool -Dbuildtype=debug ~/dev/orotool
```
This will cause the config file in your source tree to be used by orotool, so you
will have to enter an API key there. It doesn't have to be valid since you're
not connecting to the real server, but it should be still recognised by the
program as valid. Try a dummy value like aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa for example.
`ninja install` is still safe to run.
It will also set localhost as the url to the rest API. You can install and run
[SoapUI](https://www.soapui.org/) to make your computer respond on localhost:8080.
You can use the provided `sample_responses/originsro.xml` file with SoapUI.
After compiling you can run `ln -s src/orotool` in the build directory to make a
symlink to the binary. You can then run the program with `./orotool`. When testing
locally I usually run this command in just one line: `rm -fv originsro.db3 ; ninja && ./orotool`.
It will delete the SQLite database if present, compile if needed and then run orotool.
## Configuration ##
You can customise certain runtime aspects of orotool in `orotool.conf` (location
of this file depends on your build configuration). The file provided in the repository
has some sane defaults except for the API key which you have to set yourself. To
obtain an API key login to your OriginsRO control panel and generate a key [here](https://cp.originsro.org/masteraccount/view/).
## Contact ##
The best way to get in touch is on IRC: