Skip to content

Commit 1098908

Browse files
authored
README fine tuning
1 parent 048f25c commit 1098908

File tree

1 file changed

+38
-34
lines changed

1 file changed

+38
-34
lines changed

README.md

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,19 @@ C++ wrapper for Labs64 NetLicensing [RESTful API](http://l64.cc/nl10)
99
Visit Labs64 NetLicensing at https://netlicensing.io
1010

1111
## Dependencies
12-
1. Standard C++ (v.11 and above) and C libraries.
13-
2. [curl](https://github.com/curl/curl) (include all transitive dependency)
14-
3. [jsoncpp](https://github.com/open-source-parsers/jsoncpp)(included)
12+
1. C++11 STL
13+
2. [libcurl](https://github.com/curl/curl) (with libcurl's transitive dependencies)
14+
3. [jsoncpp](https://github.com/open-source-parsers/jsoncpp) (included)
1515

1616
## Compatibility
1717

18-
Building <b>NetLicensing C++ client library</b> with static linking is not supported.
18+
### Notes:
19+
20+
- Building **NetLicensing C++ client library** with static linking is currently not supported, feel free to contribute.
21+
22+
- **libcurl** version 7.64.0 was used for verified builds.
23+
24+
### Verified builds:
1925

2026
Platform | Build toolset | Supported
2127
------------ | ------------- | -------------
@@ -29,47 +35,45 @@ macOS Mojave | Xcode 10.1 | :heavy_check_mark:
2935

3036
### Build curl
3137
1. Download <b>curl</b> from https://github.com/curl/curl/releases
32-
2. <code>cd curl_directory\winbuild</code>
33-
3. Read <code>BUILD_WINDOWS.txt</code> for building instructions
34-
4. In <b>VC command prompt:</b>
35-
<pre>
36-
<code>
37-
nmake /f Makefile.vc VC=&#60;VC versions&#62; MACHINE=&#60;x86 or x64&#62; ENABLE_WINSSL=<b>yes</b> MODE=<b>dll</b>
38-
</code>
39-
</pre>
40-
5. If you get the error <code>U1073</code> or <code>U1077</code> - execute <code>curl_directory\buildconf.bat</code> first and repeat command
41-
6. Your <b>curl</b> build directory will be in sub directory <code>\builds</code>
38+
2. `cd curl_directory\winbuild`
39+
3. Read `BUILD_WINDOWS.txt` for building instructions
40+
4. In **VC command prompt**:
41+
```
42+
nmake /f Makefile.vc VC=&#60;VC versions&#62; MACHINE=&#60;x86 or x64&#62; ENABLE_WINSSL=<b>yes</b> MODE=<b>dll</b>
43+
```
44+
5. If you get the error `U1073` or `U1077` - execute `curl_directory\buildconf.bat` first and repeat the `nmake` command
45+
6. Your `curl` build directory will be in sub directory `builds\`
4246

4347
### Build NetLicensing C++ client
44-
1. Download latest release and unpack to <code>NetLicensingClient-cpp</code> (checkout muster if you want to build latest development version)
45-
2. In <code>NetLicensingClient-cpp</code> create <code>build</code> directory
46-
3. Specify <b>curl</b> <code>build</code> directory using <code>CMAKE_PREFIX_PATH=your_curl_build_directory</code>. Build directory contains <code>bin, include, lib</code> subdirs.
47-
4. In <b>VC command prompt:</b>
48-
49-
<pre>
50-
<code>
48+
1. Download the latest release and unpack to `NetLicensingClient-cpp` (or checkout [master](https://github.com/Labs64/NetLicensingClient-cpp.git) to build the latest development version)
49+
2. In the `NetLicensingClient-cpp` directory create `build\` subdirectory
50+
3. Specify **curl** location using `CMAKE_PREFIX_PATH=your_curl_build_directory`. **curl** build directory must contain `bin`, `include`, and `lib` subdirs.
51+
4. In **VC command prompt** execute:
52+
```
5153
cd NetLicensingClient-cpp\build
5254
cmake .. -G "Visual Studio <VC versions> Win&#60;86 or 64&#62;" -DCMAKE_PREFIX_PATH=your_curl_build_directory
53-
</code>
54-
</pre>
55-
5. Open solution from <code>NetLicensingClient-cpp\build</code> directory in VC and build library and demo client.
55+
```
56+
5. Open solution created in `NetLicensingClient-cpp\build` directory in Visual Studio and build the library and demo client.
5657

5758
## Linux build
5859

5960
### Build NetLincesing-cpp
60-
1. Download latest release and unpack to <code>NetLicensingClient-cpp</code> (checkout muster if you want to build latest development version)
61-
2. Install <b>curl</b> dev. For <b>Ubuntu:</b>
62-
<pre><code>sudo apt-get install libcurl4-openssl</code></pre>
63-
3. In <code>NetLicensingClient-cpp</code> create <code>build</code> directory
64-
3. Run <code>cmake ..</code> from <code>build</code> directory
65-
4. Run <code>make</code>
61+
1. Download the latest release and unpack to `NetLicensingClient-cpp` (or checkout [master](https://github.com/Labs64/NetLicensingClient-cpp.git) to build the latest development version)
62+
2. Install **curl** (for development, including C headers and libraries). E.g. in **Ubuntu**:
63+
```sudo apt-get install libcurl4-openssl```
64+
3. In the `NetLicensingClient-cpp` directory create `build/` subdirectory
65+
4. Execute:
66+
```
67+
cd NetLicensingClient-cpp/build
68+
cmake ..
69+
make
70+
```
6671

6772
### Unit tests
6873

69-
For unit tests you need installed <b>boost</b> unit test library. To build project with unit tests activated use cmake option <code>-DBUILD_TESTS=yes</code>. For example <code>cmake -DBUILD_TESTS=yes ..</code> . Run tests from <code>tests</code> directory on Linux or <code>tests/Debug</code> on Windows because of expected locations of json source files.
70-
74+
Unit tests require [**Boost**](https://www.boost.org) Unit Test Framework. To build project with the unit tests activated add cmake option `-DBUILD_TESTS=yes`. The tests must be executed from `tests/` subdirectory on Linux or `tests\Debug\` on Windows in order to properly locate the JSON files with test data.
7175

72-
## Note
7376

74-
The <b>curl</b> dynamic library should be installed either system-wide or placed along with your executable file.
77+
## Execution environment
7578

79+
**libcurl** dynamic library should be either installed system-wide or otherwise available for the loading at run-time (typically located in the same directory as your executable)

0 commit comments

Comments
 (0)