logdiag/README.adoc

116 lines
3.3 KiB
Plaintext
Raw Permalink Normal View History

2017-06-19 00:03:44 +02:00
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.
image::docs/user-guide/logdiag-en.png[align="center"]
2017-06-19 00:03:44 +02:00
Packages
--------
Regular releases are sporadic. git master should be stable enough. You can get
2018-06-24 04:24:23 +02:00
a package with the latest development version from Archlinux's AUR.
2017-06-19 00:03:44 +02:00
Requirements
------------
2018-06-27 04:26:43 +02:00
Runtime dependencies: GTK+ >= 3.8, json-glib >= 0.10.4, lua >= 5.2 +
2017-06-19 00:03:44 +02:00
Build dependencies: CMake >= 2.8
2018-06-27 04:26:43 +02:00
Build from source on Unix-like systems
--------------------------------------
2017-06-19 00:03:44 +02:00
First check that you have all the required dependencies installed, including
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.
Build from source on Windows
----------------------------
_Note that with the current method we're stuck with GTK+ 3.10.4 at best._
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-compilation 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
2018-06-24 04:24:23 +02:00
Contributing and Support
2017-06-19 00:03:44 +02:00
------------------------
2018-06-24 04:24:23 +02:00
Use https://git.janouch.name/p/logdiag to report any bugs, request features,
or submit pull requests. `git send-email` is tolerated. If you want to discuss
the project, feel free to join me at ircs://irc.janouch.name, channel #dev.
2017-06-19 00:03:44 +02:00
2018-06-24 04:24:23 +02:00
Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9
2017-06-19 00:03:44 +02:00
License
-------
This software is released under the terms of the 0BSD license, the text of which
is included within the package along with the list of authors.