Browse Source

Streamline README

Přemysl Janouch 1 year ago
parent
commit
948a332d01
Signed by: Přemysl Janouch <p.janouch@gmail.com> GPG Key ID: B715679E3A361BE6
5 changed files with 130 additions and 98 deletions
  1. 124
    0
      README.adoc
  2. 0
    98
      README.md
  3. 3
    0
      ToolchainDebianMinGW.cmake
  4. 3
    0
      ToolchainDebianMinGWW64.cmake
  5. BIN
      logdiag.png

+ 124
- 0
README.adoc View File

@@ -0,0 +1,124 @@
1
+logdiag
2
+=======
3
+
4
+'logdiag' is a simple multiplatform schematic editor written in GTK+.
5
+
6
+This software is considered to be of alpha quality and isn't recommended for
7
+regular usage.
8
+
9
+image::logdiag.png[align="center"]
10
+
11
+Packages
12
+--------
13
+Regular releases are sporadic.  git master should be stable enough.  You can get
14
+a package with the latest development version from Archlinux's AUR, or from
15
+openSUSE Build Service for the rest of mainstream distributions.  Consult the
16
+list of repositories and their respective links at:
17
+
18
+https://build.opensuse.org/project/repositories/home:pjanouch:git
19
+
20
+Requirements
21
+------------
22
+Runtime dependencies: GTK+ >= 3.8, json-glib >= 0.10.4, lua = 5.2 +
23
+Build dependencies: CMake >= 2.8
24
+
25
+Build from source on Unix-like
26
+------------------------------
27
+First check that you have all the required dependencies installed, including
28
+development packages, if your distribution provides them.
29
+
30
+Reserve a directory for an out-of-source build:
31
+
32
+ $ mkdir build
33
+ $ cd build
34
+
35
+Let CMake prepare the build. You may change the directory where you want the
36
+application to be installed. The default is _/usr/local_.
37
+
38
+ $ cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr
39
+
40
+Now you have two basic choices of installing the application.
41
+
42
+Using _make install_
43
+~~~~~~~~~~~~~~~~~~~~
44
+
45
+ # make install
46
+
47
+Using _cpack_
48
+~~~~~~~~~~~~~
49
+You have to choose a package format understood by your system package manager.
50
+CMake offers DEB and RPM.
51
+
52
+After _cpack_ finishes making the package, install this file.
53
+
54
+ $ fakeroot cpack -G DEB
55
+ # dpkg -i logdiag-version-system-arch.deb
56
+
57
+Leave out the fakeroot for CMake >= 2.8.9, it's been fixed since.
58
+
59
+Build from source on Windows
60
+----------------------------
61
+_Note that with the current method we're stuck with GTK+ 3.10.4 at best._
62
+
63
+First install CMake >= 3.1 and MinGW. Add both to your system path. If you want
64
+to build an installation package, also install NSIS.
65
+
66
+Run the following command in the directory with source files to automatically
67
+fetch and setup all dependencies (contact me if the script becomes obsolete,
68
+it's easy to fix but I usually update it only just a short while before
69
+releasing a new version in order to resolve compatibility issues):
70
+
71
+ > cmake -P Win32Depends.cmake
72
+
73
+Reserve a directory for an out-of-source build:
74
+
75
+ > mkdir build
76
+ > cd build
77
+
78
+Let CMake prepare the build:
79
+
80
+ > cmake .. -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release
81
+
82
+Now you can generate a package with CPack. You may choose between:
83
+
84
+1. An NSIS-based installation package:
85
+
86
+ > cpack -G NSIS
87
+
88
+2. A portable ZIP package:
89
+
90
+ > cpack -G ZIP
91
+
92
+By default, that is if you specify no generator, both packages are built.
93
+
94
+Cross-compilation for Windows
95
+-----------------------------
96
+
97
+The procedure is almost exactly the same as before, including the requirements.
98
+Just install MinGW-w64 and let automation take care of the rest.
99
+
100
+ $ cmake -P Win32Depends.cmake
101
+ $ mkdir build
102
+ $ cd build
103
+ $ cmake .. \
104
+   -DCMAKE_TOOLCHAIN_FILE=../ToolchainDebianMinGWW64.cmake \
105
+   -DCMAKE_BUILD_TYPE=Release
106
+ $ cpack
107
+
108
+Contributing and support
109
+------------------------
110
+Use this project's GitHub to report any bugs, request features, or submit pull
111
+requests.  If you want to discuss this project, or maybe just hang out with
112
+the developer, feel free to join me at irc://irc.janouch.name, channel #dev.
113
+
114
+Bitcoin donations: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9
115
+
116
+License
117
+-------
118
+'logdiag' is written by Přemysl Janouch <p.janouch@gmail.com>.
119
+
120
+You may use the software under the terms of the ISC license, the text of which
121
+is included within the package, or, at your option, you may relicense the work
122
+under the MIT or the Modified BSD License, as listed at the following site:
123
+
124
+http://www.gnu.org/licenses/license-list.html

+ 0
- 98
README.md View File

@@ -1,98 +0,0 @@
1
-# logdiag
2
-
3
-logdiag is a simple multiplatform schematic editor written in GTK+.
4
-
5
-__This software is considered to be of alpha quality and isn't recommended for
6
-regular usage.__
7
-
8
-## Requirements
9
-
10
-Runtime dependencies:
11
-
12
- - GTK+ &gt;= 3.8
13
- - json-glib &gt;= 0.10.4
14
- - lua = 5.2
15
-
16
-Build dependencies:
17
-
18
- - CMake &gt;= 2.8
19
-
20
-## Installation from sources on Unix-like systems
21
-
22
-First check that you have all the required dependencies installed, including
23
-all development packages, if your distribution provides them.
24
-
25
-Reserve a directory for an out-of-source build:
26
-
27
-    $ mkdir build
28
-    $ cd build
29
-
30
-Let CMake prepare the build. You may change the directory where you want the
31
-application to be installed. The default is _/usr/local_.
32
-
33
-    $ cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr
34
-
35
-Now you have two basic choices of installing the application.
36
-
37
-#### Using _make install_
38
-
39
-    # make install
40
-
41
-#### Using _cpack_
42
-
43
-You have to choose a package format understood by your system package manager.
44
-CMake offers DEB and RPM.
45
-
46
-After _cpack_ finishes making the package, install this file.
47
-
48
-    $ fakeroot cpack -G DEB
49
-    # dpkg -i logdiag-version-system-arch.deb
50
-
51
-Leave out the fakeroot for CMake >= 2.8.9, it's been fixed since.
52
-
53
-## Building from sources on Windows
54
-
55
-First install CMake >= 3.1 and MinGW. Add both to your system path. If you want
56
-to build an installation package, also install NSIS.
57
-
58
-Run the following command in the directory with source files to automatically
59
-fetch and setup all dependencies (contact me if the script becomes obsolete,
60
-it's easy to fix but I usually update it only just a short while before
61
-releasing a new version in order to resolve compatibility issues):
62
-
63
-    > cmake -P Win32Depends.cmake
64
-
65
-Reserve a directory for an out-of-source build:
66
-
67
-    > mkdir build
68
-    > cd build
69
-
70
-Let CMake prepare the build:
71
-
72
-    > cmake .. -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release
73
-
74
-Now you can generate a package with CPack. You may choose between:
75
-
76
-1. An NSIS-based installation package:
77
-
78
-    > cpack -G NSIS
79
-
80
-2. A portable ZIP package:
81
-
82
-    > cpack -G ZIP
83
-
84
-By default, that is if you specify no generator, both packages are built.
85
-
86
-## Cross-compiling for Windows
87
-
88
-The procedure is almost exactly the same as before, including the requirements.
89
-Just install MinGW-w64 and let automation take care of the rest.
90
-
91
-    $ cmake -P Win32Depends.cmake
92
-    $ mkdir build
93
-    $ cd build
94
-    $ cmake .. \
95
-      -DCMAKE_TOOLCHAIN_FILE=../ToolchainDebianMinGWW64.cmake \
96
-      -DCMAKE_BUILD_TYPE=Release
97
-    $ cpack
98
-

+ 3
- 0
ToolchainDebianMinGW.cmake View File

@@ -5,6 +5,9 @@ set (CMAKE_C_COMPILER "i586-mingw32msvc-gcc")
5 5
 set (CMAKE_CXX_COMPILER "i586-mingw32msvc-g++")
6 6
 set (CMAKE_RC_COMPILER "i586-mingw32msvc-windres")
7 7
 
8
+# Not needed to crosscompile an installation package
9
+#set (CMAKE_CROSSCOMPILING_EMULATOR "wine")
10
+
8 11
 set (CMAKE_FIND_ROOT_PATH "/usr/i586-mingw32msvc")
9 12
 
10 13
 set (CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)

+ 3
- 0
ToolchainDebianMinGWW64.cmake View File

@@ -5,6 +5,9 @@ set (CMAKE_C_COMPILER "i686-w64-mingw32-gcc")
5 5
 set (CMAKE_CXX_COMPILER "i686-w64-mingw32-g++")
6 6
 set (CMAKE_RC_COMPILER "i686-w64-mingw32-windres")
7 7
 
8
+# Not needed to crosscompile an installation package
9
+#set (CMAKE_CROSSCOMPILING_EMULATOR "wine")
10
+
8 11
 set (CMAKE_FIND_ROOT_PATH "/usr/i686-w64-mingw32")
9 12
 
10 13
 set (CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)

BIN
logdiag.png View File


Loading…
Cancel
Save