Add a README.md file.

Describe the application as a "schematic editor" everywhere.
This commit is contained in:
Přemysl Eric Janouch 2011-01-16 19:21:39 +01:00
parent f111aa05d7
commit a7cc4ef2a1
3 changed files with 44 additions and 3 deletions

View File

@ -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")

41
README.md Normal file
View File

@ -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

View File

@ -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;