Fix documents

BambooTracker · Dec 19, 2018 · 7a93432 · OPNA2608 · Dec 19, 2018 · OPNA2608
1 parent 2a650cf
commit 7a93432
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 6 deletions.
diff --git a/BambooTracker.1 b/BambooTracker.1
@@ -6,7 +6,7 @@ BambooTracker \- YM2608 (OPNA) tracker
 .RI " files" ...
 .br
 .SH DESCRIPTION
-This manual page documents briefly the
+This manual page quickly summarizes the
 .B BambooTracker
 command.
 .PP

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,10 +3,23 @@
 ## Unreleased
 ### Added
 - [#27] - Add application icon (thanks [@Decidetto])
+- [#29], [#36] - Create BambooTracker.desktop (thanks [@alexmyczko], [@trebmuh], [@OPNA2608])
+- [#30] - Create BambooTracker.1 (thanks [@alexmyczko], [@OPNA2608])
+
+### Fixed
+- [#28] - Fix error when compilung before Qt5.10 (thanks [@papiezak] and others)
+- [#33] - Revise README (thanks [@OPNA2608])
 
 [#27]: https://github.com/rerrahkr/BambooTracker/issues/27
+[#28]: https://github.com/rerrahkr/BambooTracker/issues/28
+[#29]: https://github.com/rerrahkr/BambooTracker/pull/29
+[#30]: https://github.com/rerrahkr/BambooTracker/pull/30
+[#33]: https://github.com/rerrahkr/BambooTracker/pull/33
+[#36]: https://github.com/rerrahkr/BambooTracker/pull/36
 
 [@Decidetto]: https://github.com/Decidetto
+[@alexmyczko]: https://github.com/alexmyczko
+[@trebmuh]: https://github.com/trebmuh
 
 ## v0.1.3 (2018-12-14)
 ### Added

diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # BambooTracker
 [![GitHub release](https://img.shields.io/badge/release-v0.1.3-orange.svg)](https://github.com/rerrahkr/BambooTracker/releases)
-![Platform: win-32](https://img.shields.io/badge/platform-win--32-lightgrey.svg)
-![Platform: linux](https://img.shields.io/badge/platform-linux-lightgrey.svg)
+![Platform: win-32 | linux](https://img.shields.io/badge/platform-win--32%20|%20liunx-lightgrey.svg)
 [![GitHub issues](https://img.shields.io/github/issues/rerrahkr/BambooTracker.svg)](https://github.com/rerrahkr/BambooTracker/issues)
 [![GitHub](https://img.shields.io/github/license/rerrahkr/BambooTracker.svg)](./LICENSE)
 
@@ -12,7 +11,7 @@ The files created by this tracker are called "modules". One such module contains
 In a song, the channel of each sound source is assigned to a track, and the track holds multiple patterns (performance patterns).
 The patterns are played by registering them in the order they appear the song. (from beginning to end)
 A pattern describes a structure in which steps are arranged in chronological order. Key On / off and most effects are described in step units.
-A tick is the minimum performance unit, one step = n ticks. The effects (such as vibrato) which change with the count unit are based on ticks.
+A tick is the minimum performance unit, one step = n ticks. The effects (such as vibrato) which change with the count unit are based on ticks.
 
 ## Interface Overview
 ### Instrument List
@@ -248,3 +247,5 @@ I would like to thank the following people for making it:
 - Mark James for the tool bar icons
 - VGMRips team for the VGM file format documentation.
 - Some tracker creators, especially HertzDevil of 0CC-FamiTracker, Leonardo Demartino (delek) of Deflemask Tracker and Lasse Öörni (Cadaver) of GoatTracker for UI and routines of the tracker.
+- Decidetto for the application icon.
+- And everyone who helps this project!
diff --git a/README_ja.md b/README_ja.md
@@ -1,7 +1,6 @@
 # BambooTracker
 [![GitHub release](https://img.shields.io/badge/release-v0.1.3-orange.svg)](https://github.com/rerrahkr/BambooTracker/releases)
-![Platform: win-32](https://img.shields.io/badge/platform-win--32-lightgrey.svg)
-![Platform: linux](https://img.shields.io/badge/platform-linux-lightgrey.svg)
+![Platform: win-32 | linux](https://img.shields.io/badge/platform-win--32%20|%20liunx-lightgrey.svg)
 [![GitHub issues](https://img.shields.io/github/issues/rerrahkr/BambooTracker.svg)](https://github.com/rerrahkr/BambooTracker/issues)
 [![GitHub](https://img.shields.io/github/license/rerrahkr/BambooTracker.svg)](./LICENSE)
 
@@ -210,6 +209,28 @@ FMの順番は逆転することができます。 (Configuration -> General ->
 | 0Vxx       | -                                                                                                                         | -                          | マスターボリューム (xx[00-3f]: 音量) |
 | Mxyy       | ボリューム・ディレイ (x[1-f]: ディレイカウント, yy[00-ff]: 音量)                                                          | ボリューム・ディレイ       | ボリューム・ディレイ                 |
 
+## Linuxでのビルド方法
+Ubuntu 18.10: (18.04ではQt5.10以降のバージョンが以下の方法では入手できません)
+
+### 必要なパッケージ
+> make  
+> Qt5 (qmake)  
+> Qt5 Multimedia  
+> Qt5 Multimedia plugins
+
+```bash
+sudo apt-get install \
+  build-essential \
+  qt5-default qtmultimedia5-dev libqt5multimedia5-plugins
+```
+
+### コンパイル
+```bash
+cd BambooTracker
+qmake
+make
+```
+
 ## Changelog
 *[CHANGELOG.md](./CHANGELOG.md)を参照してください。*
 
@@ -226,3 +247,5 @@ FMの順番は逆転することができます。 (Configuration -> General ->
 - ツールバーに使用しているアイコンに関してMark Jamesさん
 - VGMファイルのフォーマットのドキュメントに関してVGMRipsチームさん
 - トラッカーのUIやルーチンに関して多くのトラッカー作成者様、特に0CC-FamiTrackerのHertzDevilさん、Deflemask TrackerのLeonardo Demartino (delek)さん、GoatTrackerのLasse Öörni (Cadaver)さん
+- トラッカーのアイコンに関してDecidettoさん
+- そしてこのプロジェクトに手助けしてくださるみなさん!