summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2017-06-19 00:03:44 +0200
committerPřemysl Janouch <p.janouch@gmail.com>2017-06-19 00:03:44 +0200
commit948a332d01cab9372610b03e485f951a2dcc38bd (patch)
tree9214e78c8a3ab3ba4ecc1f54c304e80562527f68 /README.md
parentced3913e6898d6d8988e790ea7b885cfeba5b2ca (diff)
downloadlogdiag-948a332d01cab9372610b03e485f951a2dcc38bd.tar.gz
logdiag-948a332d01cab9372610b03e485f951a2dcc38bd.tar.xz
logdiag-948a332d01cab9372610b03e485f951a2dcc38bd.zip
Streamline README
Diffstat (limited to 'README.md')
-rw-r--r--README.md98
1 files changed, 0 insertions, 98 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index d7bf789..0000000
--- a/README.md
+++ /dev/null
@@ -1,98 +0,0 @@
-# logdiag
-
-logdiag is a simple multiplatform schematic editor written in GTK+.
-
-__This software is considered to be of alpha quality and isn't recommended for
-regular usage.__
-
-## Requirements
-
-Runtime dependencies:
-
- - GTK+ &gt;= 3.8
- - json-glib &gt;= 0.10.4
- - lua = 5.2
-
-Build dependencies:
-
- - CMake &gt;= 2.8
-
-## 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.
-
-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.
-
-#### Using _make install_
-
- # make install
-
-#### 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-version-system-arch.deb
-
-Leave out the fakeroot for CMake >= 2.8.9, it's been fixed since.
-
-## Building from sources on Windows
-
-First install CMake >= 3.1 and MinGW. Add both to your 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 (contact me if the script becomes obsolete,
-it's easy to fix but I usually update it only just a short while before
-releasing a new version in order to resolve compatibility issues):
-
- > cmake -P Win32Depends.cmake
-
-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
-
-Now you can generate a package with CPack. You may choose between:
-
-1. An NSIS-based installation package:
-
- > cpack -G NSIS
-
-2. A portable ZIP package:
-
- > cpack -G ZIP
-
-By default, that is if you specify no generator, both packages are built.
-
-## Cross-compiling for Windows
-
-The procedure is almost exactly the same as before, including the requirements.
-Just install MinGW-w64 and let automation take care of the rest.
-
- $ cmake -P Win32Depends.cmake
- $ mkdir build
- $ cd build
- $ cmake .. \
- -DCMAKE_TOOLCHAIN_FILE=../ToolchainDebianMinGWW64.cmake \
- -DCMAKE_BUILD_TYPE=Release
- $ cpack
-