aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2012-01-29 22:43:20 +0100
committerPřemysl Janouch <p.janouch@gmail.com>2012-01-29 22:53:09 +0100
commitd9a310a691e547af34aeca58e4b0b6b29b3e6a79 (patch)
treefe24d63db71699b166b6b9dcd4c8bbf0b8d99061
parent745bbf0ce52c8e124ce0055a17139ea67cb8315c (diff)
downloadlogdiag-d9a310a691e547af34aeca58e4b0b6b29b3e6a79.tar.gz
logdiag-d9a310a691e547af34aeca58e4b0b6b29b3e6a79.tar.xz
logdiag-d9a310a691e547af34aeca58e4b0b6b29b3e6a79.zip
Try to fix the README in GitHub.
-rw-r--r--README.md73
1 files 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+ &gt;= 2.12
- json-glib &gt;= 0.10.4
- lua = 5.1
- librsvg &gt;= 2.0
-Build dependencies:
+Build dependencies:
- CMake &gt;= 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.