aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Schink <swo-dev@marcschink.de>2017-06-15 09:41:00 +0200
committerMarc Schink <swo-dev@marcschink.de>2017-06-15 09:41:00 +0200
commit258394d58f6697859da60108a72ecd7ab7ea1f3e (patch)
treede62aa6975ba8ca67571f20f12404b25c6e9fc82
parent6ff154e5fb9acbfec141d27eb2ab9c3a575072d7 (diff)
Add initial README file
-rw-r--r--README53
1 files changed, 53 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..19eb318
--- /dev/null
+++ b/README
@@ -0,0 +1,53 @@
+swodec
+======
+
+swodec is a command-line utility to decode SWO trace data.
+
+
+Requirements
+------------
+
+swodec depends on the following packages:
+
+ - GCC (>= 4.0) or Clang
+ - Make
+ - pkg-config >= 0.26
+ - libswo >= 0.1.0
+
+If you're building swodec from Git, the follwing packets are additionally
+required:
+
+ - Git
+ - Autoconf >= 2.69
+ - Automake >= 1.11
+
+
+Building and installing
+-----------------------
+
+In order to get and build the latest Git version of swodec, run the following
+commands:
+
+ $ git clone git://git.zapb.de/swodec.git
+ $ cd swodec
+ $ ./autogen.sh
+ $ ./configure
+ $ make
+
+After `make` finishes without any errors, use the following command to install
+swodec:
+
+ $ make install
+
+
+Copyright and license
+---------------------
+
+swodec 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/swodec.git>