Page MenuHomePhabricator (Chris)
Files F118123

No OneTemporary
Actions

Authored By
Unknown
Size
4 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/docs/Readme.md b/docs/Readme.md
new file mode 100644
index 0000000..7df014f
--- /dev/null
+++ b/docs/Readme.md
@@ -0,0 +1,7 @@
+# Project Documents
+
+# Build guides:
+
+- `build_guide-en/build_guide_for_origin.md`: Original build guide on [https://soramimi.github.io/Guitar/build-en.html]
+
+- `build_guide-en/build_guide_for_linux-en.md`: Simple build guide for Linux.
diff --git a/docs/build_guide-en/build_guide_for_linux-en.md b/docs/build_guide-en/build_guide_for_linux-en.md
new file mode 100644
index 0000000..b4f539a
--- /dev/null
+++ b/docs/build_guide-en/build_guide_for_linux-en.md
@@ -0,0 +1,80 @@
+# Build the Guitar(en) on Linux
+
+Tested on Ubuntu19.04, Archlinux.
+
+# 0. Prepare:
+## 0.1. Dependencies:
+
+- GCC:
+
+- Ruby:
+
+- Perl:
+
+- Openssl:
+required openssl-1.0.x, openssl-1.1.x is not supported
+
+- zlib:
+
+__Install Dependencies__
+
+- Ubuntu:
+
+ `sudo apt install ruby perl libssl-dev zlib1g-dev`
+
+- Archlinux:
+
+ `sudo pacman -S ruby perl openssl zlib`
+
+## 0.3 Download sources
+
+ git clone git@github.com:soramimi/Guitar.git
+
+## 1. Build:
+## 1.1 Build with cmake:
+
+ cd $(YOUR_DIR)/Guitar
+ ruby prepare.rb
+ mkdir build
+ cd build
+ cmake ..
+ make -j(nproc)
+
+## 1.2 ~~Build with qmake:~~
+
+Notice: seems something wrong in `.pro` file
+
+ cd $(YOUR_DIR)/Guitar
+ ruby prepare.rb
+ mkdir build
+ cd build
+ qmake ..
+ make -j(nproc)
+
+## 1.3 Build with qtcreator:
+
+- start the QtCreator, open the project file `Guitar.pro`
+- do [Run qmake]
+- do [Build]
+
+__notice:__
+
+knowen issue: `can not find Guitar/_bin/libzd.a` when building
+
+solution: edit `Guitar.pro` line 73 to line 77.
+
+origin:
+
+ !haiku {
+ unix:CONFIG(debug, debug|release):LIBS += $$PWD/_bin/libzd.a
+ unix:CONFIG(release, debug|release):LIBS += $$PWD/_bin/libz.a
+ #unix:LIBS += -lz
+ }
+
+To:
+
+ !haiku {
+ #unix:CONFIG(debug, debug|release):LIBS += $$PWD/_bin/libzd.a
+ #unix:CONFIG(release, debug|release):LIBS += $$PWD/_bin/libz.a
+ unix:LIBS += -lz
+ }
diff --git a/docs/build_guide-en/build_guide_origin.md b/docs/build_guide-en/build_guide_origin.md
new file mode 100644
index 0000000..d86d4f2
--- /dev/null
+++ b/docs/build_guide-en/build_guide_origin.md
@@ -0,0 +1,118 @@
+# How to build the Guitar (en) (draft)
+
+# 0. Prerequirements
+
+## 0.1 Compiler
+
+__Windows__
+
+ Microsoft Visual C++ 2013 or later
+ Ruby : https://rubyinstaller.org/
+ Perl : https://www.activestate.com/activeperl
+
+__mac OS__
+
+ Xcode
+ Ruby
+ Perl
+
+__Linux (Ubuntu)__
+
+ GCC
+ Ruby: sudo apt-get install ruby
+ Perl: sudo apt-get install perl
+
+## 0.2 Dependent libraries
+
+Qt : https://www.qt.io/download-open-source/#section-2
+- Please download and install Qt SDK suitable for your platform.
+
+zlib : https://github.com/madler/zlib.git
+
+OpenSSL : https://www.openssl.org/source/ | https://github.com/openssl/openssl.git
+- required openssl-1.0.x
+- openssl-1.1.x is not supported
+
+## 0.3 Download sources
+
+- Guitar
+
+ (https) git clone https://github.com/soramimi/Guitar.git
+ (ssh) git clone git@github.com:soramimi/Guitar.git
+
+- zlib
+
+ git clone https://github.com/madler/zlib.git
+
+- OpenSSL
+
+ git clone https://github.com/openssl/openssl.git
+ ...or download source from https://www.openssl.org/source/
+
+
+
+## 0.3 Directories (example)
+
+ /home/my/work/Guitar
+ /home/my/work/openssl
+ /home/my/work/zlib
+
+# 1. Make the zlib
+
+Start the Qt Creator and open Guitar/zlib.pro
+
+- Set build directory to:
+
+- (ex. for Windows) `C:\work\_build_zlib`
+
+- (ex. for Linux/mac) `/home/my/work/_build_zlib_Debug|Release`
+
+Run [Build] menu (or press Ctrl+B)
+
+
+---
+
+__Make OpenSSL on Windows__
+
+please read the INSTALL.W32
+
+recommended to install the OpenSSL on `C:\openssl`
+
+ perl Configure VC-WIN32 --prefix=c:\openssl
+
+
+__Make OpenSSL on macOS__
+
+ $ cd openssl
+ $ git checkout -b OpenSSL_1_0_2-stable origin/OpenSSL_1_0_2-stable
+ $ ./Configure darwin64-x86_64-cc --prefix=/usr/local
+ $ make -j4
+ $ sudo make install
+
+
+__Install OpenSSL on Linux__
+
+ $ sudo apt-get install libssl-dev
+
+
+# 1. Make the Guitar
+
+first, run the script 'prepare.rb'
+
+ $ cd Guitar
+ $ ruby prepare.rb
+
+start the Qt Creator, open the project file 'Guitar.pro'
+- Set build directory to:
+
+ (ex. for Windows) `C:\work\_build_Guitar`
+
+ (ex. for Linux/mac) `/home/my/work/_build_Guitar_Debug|Release`
+
+- do [Run qmake] (in [Build] menu)
+- do [Build] (or press Ctrl+B)
+
+
+# Note
+
+(on Windows) necessary to copy OpenSSL's 'libeay32.dll' and 'ssleay32.dll' to the same folder as 'Guitar.exe'.

File Metadata

Mime Type
text/x-diff
Expires
Fri, May 15, 9:35 AM (11 h, 56 m ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
63917
Default Alt Text
(4 KB)

Event Timeline