p
/
logdiag
1
1
Fork 0
Code Issues Pull Requests Releases 4 Wiki Activity

Try to fix the README in GitHub.

This commit is contained in:
Přemysl Eric Janouch 2012-01-29 22:43:20 +01:00
parent 745bbf0ce5
commit d9a310a691
1 changed files with 42 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -2,70 +2,81 @@
logdiag is a schematic editor written in GTK+. logdiag is a schematic editor written in GTK+.
__This software is considered to be alpha quality and cannot be recommended __This software is considered to be alpha quality and isn't recommended for
for regular usage.__ regular usage.__
## Requirements ## Requirements
Runtime dependencies: Runtime dependencies:
- GTK+ >= 2.12 - GTK+ >= 2.12
- json-glib >= 0.10.4 - json-glib >= 0.10.4
- lua = 5.1 - lua = 5.1
- librsvg >= 2.0 - librsvg >= 2.0
Build dependencies: Build dependencies:
- CMake >= 2.6 - CMake >= 2.6
## Installation from sources on Unix-like systems ## Installation from sources on Unix-like systems
First check that you have all the required dependencies installed, including First check that you have all the required dependencies installed, including
all development packages, if your distribution provides them. all development packages, if your distribution provides them.
Reserve a directory for an out-of-source build:
Reserve a directory for an out-of-source build:
$ mkdir build $ mkdir build
$ cd build $ cd build
Let CMake prepare the build. You may change the directory where you want Let CMake prepare the build. You may change the directory where you want the
the application to be installed. The default is _/usr/local_. 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: $ cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr
1. Using _make install_: Now you have two basic choices of installing the application.
# make install
2. Using _cpack_; you have to choose a package format understood by your #### Using _make install_
system package manager. CMake offers DEB and RPM.
After _cpack_ finishes making the package, install this file. # make install
$ fakeroot cpack -G DEB
# dpkg -i logdiag-0.0-Linux-x86_64.deb #### 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.
$ fakeroot cpack -G DEB
# dpkg -i logdiag-0.0-Linux-x86_64.deb
## Building from sources on Windows ## Building from sources on Windows
First install CMake 2.8 and MinGW. Add both to the system path. First install CMake 2.8 and MinGW. Add both to the system path. If you want to
If you want to build an installation package, also install NSIS. build an installation package, also install NSIS.
Run the following command in the directory with source files to automatically
fetch and setup all dependencies:
Run the following command in the directory with source files
to automatically fetch and setup all dependencies:
> cmake -P Win32Depends.cmake > cmake -P Win32Depends.cmake
Reserve a directory for an out-of-source build: Reserve a directory for an out-of-source build:
> mkdir build > mkdir build
> cd build > cd build
Let CMake prepare the build: Let CMake prepare the build:
> cmake .. -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release
Now you can generate a package with CPack. You may choose between: > cmake .. -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release
1. An NSIS-based installation package: Now you can generate a package with CPack. You may choose between:
> cpack -G NSIS
2. A portable ZIP package: 1. An NSIS-based installation package:
> cpack -G ZIP
By default, that is if you specify no generator, both packages are built. > cpack -G NSIS
2. A portable ZIP package:
> cpack -G ZIP
By default, that is if you specify no generator, both packages are built.