aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Schink <swo-dev@marcschink.de>2016-03-20 11:54:20 +0100
committerMarc Schink <swo-dev@marcschink.de>2017-06-15 09:13:54 +0200
commitf8462891d5eeb61532550a69edf1bc9cbe5bdcb6 (patch)
tree735ee3c44f566dee31c2d5d4ffeb7f2f45c36917
parentce41b0cf398a3a610c58b3457993ed1e101d4651 (diff)
Add initial README file
-rw-r--r--README66
1 files changed, 66 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..402b140
--- /dev/null
+++ b/README
@@ -0,0 +1,66 @@
+libswo
+======
+
+libswo is a shared library written in C to decode SWO trace data.
+
+
+Requirements
+------------
+
+libswo depends on the following packages:
+
+ - GCC (>= 4.0) or Clang
+ - Make
+ - pkg-config >= 0.23
+ - Doxygen (optional, only required for API documentation)
+
+If you're building libswo from Git, the following packets are additionally
+required:
+
+ - Git
+ - Libtool
+ - Autoconf >= 2.64
+ - Automake >= 1.9
+
+Requirements for the C++ bindings:
+
+ - libswo >= 0.1.0
+ - g++ (>= 4.7) or Clang++ (>= 3.0)
+
+Requirements for the Python bindings:
+
+ - libswocxx >= 0.1.0 (libswo C++ bindings, see above)
+ - Python >= 2.7 or Python >= 3.2
+ - Python setuptools
+ - SWIG >= 2.0
+
+
+Building and installing
+-----------------------
+
+In order to get and build the latest Git version of libswo, run the following
+commands:
+
+ $ git clone git://git.zapb.de/libswo.git
+ $ cd libswo
+ $ ./autogen.sh
+ $ ./configure
+ $ make
+
+After `make` finishes without any errors, use the following command to install
+libswo:
+
+ $ make install
+
+
+Copyright and license
+---------------------
+
+libswo is licensed under the terms of the GNU General Public License (GPL),
+version 3 or later. See COPYING file for details.
+
+
+Website
+-------
+
+<http://git.zapb.de/libswo.git>