Skip to content

Commit 7f2412d

Browse files
committed
update Readme
1 parent cf3d4a0 commit 7f2412d

1 file changed

Lines changed: 35 additions & 17 deletions

File tree

README.md

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,49 +9,67 @@ 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)
1215

13-
1. [curl](https://github.com/curl/curl)
14-
2. [jsoncpp](https://github.com/open-source-parsers/jsoncpp)(included)
16+
## Compatibility
17+
18+
Building <b>NetLicensing C++ client library</b> with static linking is not supported.
19+
20+
Platform | Build toolset | Supported
21+
------------ | ------------- | -------------
22+
Windows 7 | Visual studio 14 2015 x86 - x64 | [x]
23+
Windows 7 | Visual studio 15 2017 x86 - x64 | [x]
24+
Windows 10 | Visual studio 14 2015 x86 - x64 | [x]
25+
Windows 10 | Visual studio 15 2017 x86 - x64| [x]
26+
macOS Mojave | Xcode 10.1 | [x]
1527

1628
## Windows build
1729

1830
### Build curl
19-
1. Download curl from https://github.com/curl/curl/releases
31+
1. Download <b>curl</b> from https://github.com/curl/curl/releases
2032
2. <code>cd curl_directory\winbuild</code>
2133
3. Read <code>BUILD_WINDOWS.txt</code> for building instructions
22-
4. In VC command prompt run command like
34+
4. In <b>VC command prompt:</b>
2335
<pre>
2436
<code>
2537
nmake /f Makefile.vc VC=&#60;VC versions&#62; MACHINE=&#60;x86 or x64&#62; ENABLE_WINSSL=<b>yes</b> MODE=<b>dll</b>
2638
</code>
2739
</pre>
28-
5. If you get the error "U1073" or "U1077" - execute <code>curl_directory\buildconf.bat</code> first and repeat command
29-
6. Your curl build directory will be in sub directory <code>\builds</code>
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>
3042

3143
### Build NetLicensing C++ client
32-
1. Checkout project
33-
2. In NetLicensingClient-cpp create build directory
34-
3. Setup curl home directory for example using CMAKE_PREFIX_PATH=your_curl_build_directory. Build directory contains <b>bin</b>, <b>include</b> and <b>lib</b> subdirs.
35-
3. In VC Command prompt:
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>
3648

3749
<pre>
3850
<code>
3951
cd NetLicensingClient-cpp\build
4052
cmake .. -G "Visual Studio <VC versions> Win&#60;86 or 64&#62;" -DCMAKE_PREFIX_PATH=your_curl_build_directory
4153
</code>
4254
</pre>
43-
2. Open solution from "<b>NetLicensingClient-cpp\build</b>" directory in VC and build library and demo client.
44-
55+
5. Open solution from <code>NetLicensingClient-cpp\build</code> directory in VC and build library and demo client.
4556

4657
## Linux build
4758

4859
### Build NetLincesing-cpp
49-
1. Install curl dev. For ubuntu sudo apt-get install libcurl4-openssl-dev
50-
2. Checkout NetLicensingClient-cpp
51-
3. Run cmake or cmake .. from build sub directory
52-
4. make
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>
5366

5467
### Unit tests
5568

56-
For unit tests you need installed boost unit test library. To build project with unit tests activated use cmake option -DBUILD_TESTS=yes. For example cmake -DBUILD_TESTS=yes .. . Run tests exactly from tests directory in linux or tests/Debug on windows because of expected positions of json source files.
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+
71+
72+
## Note
73+
74+
The <b>curl</b> dynamic library should be installed either system-wide or placed along with your executable file.
5775

0 commit comments

Comments
 (0)