diff options
author | Přemysl Janouch <p.janouch@gmail.com> | 2011-01-16 19:21:39 +0100 |
---|---|---|
committer | Přemysl Janouch <p.janouch@gmail.com> | 2011-01-16 19:54:53 +0100 |
commit | a7cc4ef2a1798b215f49cfd7ee25b53339d0a883 (patch) | |
tree | 1f986c55437585c988406c478e4c501cb44aa0ea /README.md | |
parent | f111aa05d7a5c2738b185aaae3510e7a04033d4e (diff) | |
download | logdiag-a7cc4ef2a1798b215f49cfd7ee25b53339d0a883.tar.gz logdiag-a7cc4ef2a1798b215f49cfd7ee25b53339d0a883.tar.xz logdiag-a7cc4ef2a1798b215f49cfd7ee25b53339d0a883.zip |
Add a README.md file.
Describe the application as a "schematic editor" everywhere.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 41 |
1 files changed, 41 insertions, 0 deletions
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 + |