aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CMakeLists.txt2
-rw-r--r--README.md41
-rw-r--r--share/logdiag.desktop4
3 files changed, 44 insertions, 3 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt
index ffbf681..ecec2e8 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -193,7 +193,7 @@ if (NOT WIN32)
endif (NOT WIN32)
# CPack
-set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "Electric diagram designer.")
+set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "Schematic editor")
set (CPACK_PACKAGE_VENDOR "Přemysl Janouch")
set (CPACK_PACKAGE_CONTACT "p.janouch@gmail.com")
set (CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
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
+
diff --git a/share/logdiag.desktop b/share/logdiag.desktop
index 6f53d54..485e0de 100644
--- a/share/logdiag.desktop
+++ b/share/logdiag.desktop
@@ -1,8 +1,8 @@
[Desktop Entry]
Type=Application
Name=logdiag
-GenericName=Electric diagrams designer
-GenericName[cs]=Návrhář elektrických diagramů
+GenericName=Schematic Editor
+GenericName[cs]=Editor schémat
Icon=logdiag
Exec=logdiag %f
Categories=Graphics;VectorGraphics;Electricity;Engineering;GTK;