From a7cc4ef2a1798b215f49cfd7ee25b53339d0a883 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Sun, 16 Jan 2011 19:21:39 +0100 Subject: Add a README.md file. Describe the application as a "schematic editor" everywhere. --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..a9678ea --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# logdiag + +logdiag is a schematic editor written in GTK+. It focuses on simplicity, +usability and openness. + +## Requirements + +Runtime dependencies: + + - GTK+ >= 2.12 + - json-glib >= 0.10 + - lua = 5.1 + +Build dependencies: + + - CMake >= 2.6 + +## Installation on Unix-like systems + +First check that you have all the required dependencies installed. + +Reserve a directory for an out-of-source build: + $ mkdir build + $ cd build + +Let CMake prepare the build. You may change the directory where you want +the application to be installed. The default is _/usr/local_. + $ cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr + +Now you have two basic choices of installing the application: + +1. Using _make install_: + # make install + +2. Using _cpack_; you have to choose a package format understood by your + system package manager. CMake offers DEB and RPM. + + After _cpack_ finishes making the package, install this file. + $ cpack -G DEB + # dpkg -i logdiag-0.0-Linux-x86_64.deb + -- cgit v1.2.3