From 29be65ea91d9946c350c8a65e90cecaabf03e8e4 Mon Sep 17 00:00:00 2001
From: Maximilien Siavelis <maximilien.siavelis@simulease.com>
Date: 周日, 14 1月 2018 21:11:59 +0800
Subject: [PATCH] adding an example

---
 README.md |   39 ++++++++++++++++++++++++++-------------
 1 files changed, 26 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 295c125..88c64b4 100644
--- a/README.md
+++ b/README.md
@@ -26,15 +26,12 @@
 The project comes out with a very large freedom of use for everyone (and it will always be). 
 It uses a BSD 3 clauses licensing schema. 
 
-Elsewhere on Internet
-=====================
- * Wiki main page:
- * Install and build :
- * Project web site :
-
-
 How to build
 ============
+
+## prerequisites
+GCC (Linux), MINGW or MSVC (Windows)
+cmake, boost, openssl (Linux/MINGW)
 
 ```
 git clone https://github.com/open-license-manager/open-license-manager.git
@@ -43,8 +40,7 @@
 cd build
 ```
 
-## on Linux :
-
+## on Linux
 ```
 cmake .. -DCMAKE_INSTALL_PREFIX=../install
 make
@@ -52,14 +48,12 @@
 ```
 
 ## on Windows (with MSVC 2010)
-
 ```
 cmake .. -G "Visual Studio 10 2010 Win64" -DCMAKE_INSTALL_PREFIX=../install
 cmake --build . --target install --config Release
 ```
 
 ## cross compile with MINGW on Linux
-
 ```
 x86_64-w64-mingw32.static-cmake .. -DCMAKE_INSTALL_PREFIX=../install
 make
@@ -69,12 +63,31 @@
 How to test
 ===========
 
-## on Linux :
+## on Linux
 ```
 make test
 ```
 
-## on Windows :
+## on Windows (MSVC)
 ```
 ctest -C Release
 ```
+
+How to use
+==========
+
+This simple example shows how to integrate open-licence-manager into your project
+
+```
+$ cd example
+$ cmake .
+$ make
+$ ./example
+license ERROR :
+    license file not found
+the pc signature is :
+    Jaaa-aaaa-MG9F-ZhBB
+$ ../install/bin/license_generator example -s Jaaa-aaaa-MG9F-ZhBB -o example.lic 
+$ ./example
+licence OK
+```

--
Gitblit v1.9.1