From d9a310a691e547af34aeca58e4b0b6b29b3e6a79 Mon Sep 17 00:00:00 2001 From: Přemysl Janouch Date: Sun, 29 Jan 2012 22:43:20 +0100 Subject: Try to fix the README in GitHub. --- README.md | 73 ++++++++++++++++++++++++++++++++++++--------------------------- 1 file changed, 42 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 0be6dc5..a09a9bb 100644 --- a/README.md +++ b/README.md @@ -2,70 +2,81 @@ logdiag is a schematic editor written in GTK+. -__This software is considered to be alpha quality and cannot be recommended -for regular usage.__ +__This software is considered to be alpha quality and isn't recommended for +regular usage.__ ## Requirements -Runtime dependencies: +Runtime dependencies: - GTK+ >= 2.12 - json-glib >= 0.10.4 - lua = 5.1 - librsvg >= 2.0 -Build dependencies: +Build dependencies: - CMake >= 2.6 ## Installation from sources on Unix-like systems -First check that you have all the required dependencies installed, including -all development packages, if your distribution provides them. +First check that you have all the required dependencies installed, including +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 $ 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 +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. + +#### Using _make install_ + + # make install -Now you have two basic choices of installing the application: +#### Using _cpack_ -1. Using _make install_: - # make install +You have to choose a package format understood by your system package manager. +CMake offers DEB and RPM. -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. - After _cpack_ finishes making the package, install this file. - $ fakeroot cpack -G DEB - # dpkg -i logdiag-0.0-Linux-x86_64.deb + $ fakeroot cpack -G DEB + # dpkg -i logdiag-0.0-Linux-x86_64.deb ## Building from sources on Windows -First install CMake 2.8 and MinGW. Add both to the system path. -If you want to build an installation package, also install NSIS. +First install CMake 2.8 and MinGW. Add both to the system path. If you want to +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 -Reserve a directory for an out-of-source build: +Reserve a directory for an out-of-source build: + > mkdir build > cd build -Let CMake prepare the build: - > cmake .. -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release +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: + +1. An NSIS-based installation package: -Now you can generate a package with CPack. You may choose between: + > cpack -G NSIS -1. An NSIS-based installation package: - > cpack -G NSIS +2. A portable ZIP package: -2. A portable ZIP package: - > cpack -G ZIP + > cpack -G ZIP -By default, that is if you specify no generator, both packages are built. +By default, that is if you specify no generator, both packages are built. -- cgit v1.2.3-70-g09d2