Page Menu
Home
Phabricator (Chris)
Search
Configure Global Search
Log In
Files
F118100
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Authored By
Unknown
Size
14 KB
Referenced Files
None
Subscribers
None
View Options
diff --git a/Doxy.conf b/Doxy.conf
new file mode 100644
index 0000000..7e32752
--- /dev/null
+++ b/Doxy.conf
@@ -0,0 +1,14 @@
+OUTPUT_DIRECTORY = ./docs/src_docs
+EXTRACT_ALL = yes
+EXTRACT_PRIVATE = yes
+EXTRACT_STATIC = yes
+
+HAVE_DOT = yes
+CLASS_DIAGRAMS = yes
+CALL_GRAPH = yes
+
+RECURSIVE = yes
+INPUT = ./src
+#common formats like .c/.cc/.cxx/.c++/.cpp/.inl/.h/.hpp
+#FILE_PATTERNS = .c .h
+RECURSIVE = yes
diff --git a/docs/Readme.md b/docs/Readme.md
new file mode 100644
index 0000000..b6f143e
--- /dev/null
+++ b/docs/Readme.md
@@ -0,0 +1,16 @@
+# 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.
+
+# Source code documents:
+
+Generate source code documents with `doxygen`:
+
+ cd ${YOUR_DIR}/Guitar
+ ./generate_src_docs.sh
+
+Then you'll get a folder at `${YOUR_DIR}/Guitar/docs/src_docs` for source code documents.
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'.
diff --git a/docs/Templates/soramimi.dwt b/docs/html/Templates/soramimi.dwt
similarity index 100%
rename from docs/Templates/soramimi.dwt
rename to docs/html/Templates/soramimi.dwt
diff --git a/docs/banner.png b/docs/html/banner.png
similarity index 100%
rename from docs/banner.png
rename to docs/html/banner.png
diff --git a/docs/banner.psd b/docs/html/banner.psd
similarity index 100%
rename from docs/banner.psd
rename to docs/html/banner.psd
diff --git a/docs/blankapp.png b/docs/html/blankapp.png
similarity index 100%
rename from docs/blankapp.png
rename to docs/html/blankapp.png
diff --git a/docs/build-en.html b/docs/html/build-en.html
similarity index 100%
rename from docs/build-en.html
rename to docs/html/build-en.html
diff --git a/docs/build.html b/docs/html/build.html
similarity index 100%
rename from docs/build.html
rename to docs/html/build.html
diff --git a/docs/classinfo.png b/docs/html/classinfo.png
similarity index 100%
rename from docs/classinfo.png
rename to docs/html/classinfo.png
diff --git a/docs/codingstyle.html b/docs/html/codingstyle.html
similarity index 100%
rename from docs/codingstyle.html
rename to docs/html/codingstyle.html
diff --git a/docs/common.js b/docs/html/common.js
similarity index 100%
rename from docs/common.js
rename to docs/html/common.js
diff --git a/docs/copyright.txt b/docs/html/copyright.txt
similarity index 100%
rename from docs/copyright.txt
rename to docs/html/copyright.txt
diff --git a/docs/cover.png b/docs/html/cover.png
similarity index 100%
rename from docs/cover.png
rename to docs/html/cover.png
diff --git a/docs/final.png b/docs/html/final.png
similarity index 100%
rename from docs/final.png
rename to docs/html/final.png
diff --git a/docs/firstapp.png b/docs/html/firstapp.png
similarity index 100%
rename from docs/firstapp.png
rename to docs/html/firstapp.png
diff --git a/docs/github.png b/docs/html/github.png
similarity index 100%
rename from docs/github.png
rename to docs/html/github.png
diff --git a/docs/guitaricon.png b/docs/html/guitaricon.png
similarity index 100%
rename from docs/guitaricon.png
rename to docs/html/guitaricon.png
diff --git a/docs/index.html b/docs/html/index.html
similarity index 100%
rename from docs/index.html
rename to docs/html/index.html
diff --git a/docs/libgit2build.png b/docs/html/libgit2build.png
similarity index 100%
rename from docs/libgit2build.png
rename to docs/html/libgit2build.png
diff --git a/docs/newproject.png b/docs/html/newproject.png
similarity index 100%
rename from docs/newproject.png
rename to docs/html/newproject.png
diff --git a/docs/openproject.png b/docs/html/openproject.png
similarity index 100%
rename from docs/openproject.png
rename to docs/html/openproject.png
diff --git a/docs/projectsettings1.png b/docs/html/projectsettings1.png
similarity index 100%
rename from docs/projectsettings1.png
rename to docs/html/projectsettings1.png
diff --git a/docs/projectsettings2.png b/docs/html/projectsettings2.png
similarity index 100%
rename from docs/projectsettings2.png
rename to docs/html/projectsettings2.png
diff --git a/docs/projectsettings3.png b/docs/html/projectsettings3.png
similarity index 100%
rename from docs/projectsettings3.png
rename to docs/html/projectsettings3.png
diff --git a/docs/projectsettings4.png b/docs/html/projectsettings4.png
similarity index 100%
rename from docs/projectsettings4.png
rename to docs/html/projectsettings4.png
diff --git a/docs/projectsettings5.png b/docs/html/projectsettings5.png
similarity index 100%
rename from docs/projectsettings5.png
rename to docs/html/projectsettings5.png
diff --git a/docs/qiita.png b/docs/html/qiita.png
similarity index 100%
rename from docs/qiita.png
rename to docs/html/qiita.png
diff --git a/docs/qmake.png b/docs/html/qmake.png
similarity index 100%
rename from docs/qmake.png
rename to docs/html/qmake.png
diff --git a/docs/qtcreator.png b/docs/html/qtcreator.png
similarity index 100%
rename from docs/qtcreator.png
rename to docs/html/qtcreator.png
diff --git a/docs/qtwidgetapp.png b/docs/html/qtwidgetapp.png
similarity index 100%
rename from docs/qtwidgetapp.png
rename to docs/html/qtwidgetapp.png
diff --git a/docs/repo.png b/docs/html/repo.png
similarity index 100%
rename from docs/repo.png
rename to docs/html/repo.png
diff --git a/docs/screenshots/commitgraph.png b/docs/html/screenshots/commitgraph.png
similarity index 100%
rename from docs/screenshots/commitgraph.png
rename to docs/html/screenshots/commitgraph.png
diff --git a/docs/screenshots/diffview.png b/docs/html/screenshots/diffview.png
similarity index 100%
rename from docs/screenshots/diffview.png
rename to docs/html/screenshots/diffview.png
diff --git a/docs/screenshots/gpgsign.png b/docs/html/screenshots/gpgsign.png
similarity index 100%
rename from docs/screenshots/gpgsign.png
rename to docs/html/screenshots/gpgsign.png
diff --git a/docs/screenshots/haiku.png b/docs/html/screenshots/haiku.png
similarity index 100%
rename from docs/screenshots/haiku.png
rename to docs/html/screenshots/haiku.png
diff --git a/docs/screenshots/httpauth.png b/docs/html/screenshots/httpauth.png
similarity index 100%
rename from docs/screenshots/httpauth.png
rename to docs/html/screenshots/httpauth.png
diff --git a/docs/screenshots/macos.png b/docs/html/screenshots/macos.png
similarity index 100%
rename from docs/screenshots/macos.png
rename to docs/html/screenshots/macos.png
diff --git a/docs/screenshots/overview.png b/docs/html/screenshots/overview.png
similarity index 100%
rename from docs/screenshots/overview.png
rename to docs/html/screenshots/overview.png
diff --git a/docs/screenshots/raspberrypi.jpg b/docs/html/screenshots/raspberrypi.jpg
similarity index 100%
rename from docs/screenshots/raspberrypi.jpg
rename to docs/html/screenshots/raspberrypi.jpg
diff --git a/docs/screenshots/raspberrypi0.jpg b/docs/html/screenshots/raspberrypi0.jpg
similarity index 100%
rename from docs/screenshots/raspberrypi0.jpg
rename to docs/html/screenshots/raspberrypi0.jpg
diff --git a/docs/screenshots/raspberrypi1.jpg b/docs/html/screenshots/raspberrypi1.jpg
similarity index 100%
rename from docs/screenshots/raspberrypi1.jpg
rename to docs/html/screenshots/raspberrypi1.jpg
diff --git a/docs/screenshots/sshconfirm.png b/docs/html/screenshots/sshconfirm.png
similarity index 100%
rename from docs/screenshots/sshconfirm.png
rename to docs/html/screenshots/sshconfirm.png
diff --git a/docs/screenshots/ubuntu.png b/docs/html/screenshots/ubuntu.png
similarity index 100%
rename from docs/screenshots/ubuntu.png
rename to docs/html/screenshots/ubuntu.png
diff --git a/docs/screenshots/windows.png b/docs/html/screenshots/windows.png
similarity index 100%
rename from docs/screenshots/windows.png
rename to docs/html/screenshots/windows.png
diff --git a/docs/selectkit.png b/docs/html/selectkit.png
similarity index 100%
rename from docs/selectkit.png
rename to docs/html/selectkit.png
diff --git a/docs/style/bg.gif b/docs/html/style/bg.gif
similarity index 100%
rename from docs/style/bg.gif
rename to docs/html/style/bg.gif
diff --git a/docs/style/common.js b/docs/html/style/common.js
similarity index 100%
rename from docs/style/common.js
rename to docs/html/style/common.js
diff --git a/docs/style/dot-blue.gif b/docs/html/style/dot-blue.gif
similarity index 100%
rename from docs/style/dot-blue.gif
rename to docs/html/style/dot-blue.gif
diff --git a/docs/style/dot-green.gif b/docs/html/style/dot-green.gif
similarity index 100%
rename from docs/style/dot-green.gif
rename to docs/html/style/dot-green.gif
diff --git a/docs/style/dot-orange.gif b/docs/html/style/dot-orange.gif
similarity index 100%
rename from docs/style/dot-orange.gif
rename to docs/html/style/dot-orange.gif
diff --git a/docs/style/dot-pink.gif b/docs/html/style/dot-pink.gif
similarity index 100%
rename from docs/style/dot-pink.gif
rename to docs/html/style/dot-pink.gif
diff --git a/docs/style/dot.gif b/docs/html/style/dot.gif
similarity index 100%
rename from docs/style/dot.gif
rename to docs/html/style/dot.gif
diff --git a/docs/style/file.png b/docs/html/style/file.png
similarity index 100%
rename from docs/style/file.png
rename to docs/html/style/file.png
diff --git a/docs/style/folder.png b/docs/html/style/folder.png
similarity index 100%
rename from docs/style/folder.png
rename to docs/html/style/folder.png
diff --git a/docs/style/h1bg.png b/docs/html/style/h1bg.png
similarity index 100%
rename from docs/style/h1bg.png
rename to docs/html/style/h1bg.png
diff --git a/docs/style/minibanner.png b/docs/html/style/minibanner.png
similarity index 100%
rename from docs/style/minibanner.png
rename to docs/html/style/minibanner.png
diff --git a/docs/style/style.css b/docs/html/style/style.css
similarity index 100%
rename from docs/style/style.css
rename to docs/html/style/style.css
diff --git a/docs/uselibgit2.png b/docs/html/uselibgit2.png
similarity index 100%
rename from docs/uselibgit2.png
rename to docs/html/uselibgit2.png
diff --git a/generate_src_docs.sh b/generate_src_docs.sh
new file mode 100755
index 0000000..c0058c6
--- /dev/null
+++ b/generate_src_docs.sh
@@ -0,0 +1,2 @@
+#!/bin/bash
+doxygen ./Doxy.conf
File Metadata
Details
Attached
Mime Type
text/x-diff
Expires
Fri, May 15, 8:49 AM (13 h, 44 m ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
63897
Default Alt Text
(14 KB)
Attached To
Mode
R77 Guitar
Attached
Detach File
Event Timeline