Browse Source

first version of the build documentation

Julius Pfrommer 8 years ago
parent
commit
cb849e3190
2 changed files with 43 additions and 0 deletions
  1. 42 0
      doc/building.rst
  2. 1 0
      doc/index.rst

+ 42 - 0
doc/building.rst

@@ -0,0 +1,42 @@
+Building the Library
+====================
+
+Building the Single-File Release
+--------------------------------
+
+Using the GCC compiler, the following calls build the library on Linux.
+.. code-block:: bash
+
+    gcc -std=c99 -fPIC -c open62541.c
+    gcc -shared open62541.o -o libopen62541.so
+   
+
+Building with CMake on Ubuntu
+-----------------------------
+
+.. code-block:: bash
+   
+   sudo apt-get install git build-essential gcc cmake python python-lxml
+
+   # enable additional features
+   sudo apt-get install libexpat1-dev # for XML-encodingi
+   sudo apt-get install liburcu-dev # for multithreading
+   sudo apt-get install check # for unit tests
+   sudo apt-get install graphviz doxygen # for documentation generation
+
+   cd open62541
+   mkdir build
+   cd build
+   cmake ..
+   make
+
+   # select additional features
+   ccmake ..
+   make
+   
+Build Options
+-------------
+
+
+Building the Examples
+=====================

+ 1 - 0
doc/index.rst

@@ -5,6 +5,7 @@ Welcome to open62541's documentation!
    :maxdepth: 2
    :hidden:
 
+   building
    datatypes
 
 `OPC UA <http://en.wikipedia.org/wiki/OPC_Unified_Architecture>`_ (short for OPC