From 17464b64465c88099c89a3d0d19376ce3f517c9a Mon Sep 17 00:00:00 2001 From: tildearrow Date: Mon, 5 Jun 2023 00:08:37 -0500 Subject: [PATCH] move documentation out of papers --- CMakeLists.txt | 3 ++- README.md | 4 ++-- TODO.md | 10 +++++----- {papers/doc => doc}/1-intro/README.md | 0 {papers/doc => doc}/1-intro/hex.md | 0 {papers/doc => doc}/2-interface/README.md | 0 {papers/doc => doc}/2-interface/asset-list.md | 0 {papers/doc => doc}/2-interface/basic-mode.md | 0 {papers/doc => doc}/2-interface/components.md | 0 {papers/doc => doc}/2-interface/docking.png | Bin {papers/doc => doc}/2-interface/interface1.png | Bin {papers/doc => doc}/2-interface/keyboard.md | 0 {papers/doc => doc}/2-interface/menu-bar.md | 0 .../doc => doc}/2-interface/play-edit-controls.md | 0 {papers/doc => doc}/2-interface/song-info.md | 0 {papers/doc => doc}/2-interface/tab1.png | Bin {papers/doc => doc}/2-interface/tab2.png | Bin {papers/doc => doc}/2-interface/tab3.png | Bin {papers/doc => doc}/2-interface/window.png | Bin {papers/doc => doc}/3-pattern/README.md | 0 {papers/doc => doc}/3-pattern/channelbar.png | Bin {papers/doc => doc}/3-pattern/channels.png | Bin {papers/doc => doc}/3-pattern/effects.md | 0 {papers/doc => doc}/3-pattern/keyboard.png | Bin {papers/doc => doc}/3-pattern/pattern.png | Bin {papers/doc => doc}/4-instrument/8930.md | 0 {papers/doc => doc}/4-instrument/README.md | 0 {papers/doc => doc}/4-instrument/amiga.md | 0 {papers/doc => doc}/4-instrument/ay8910.md | 0 {papers/doc => doc}/4-instrument/c64.md | 0 {papers/doc => doc}/4-instrument/fm.md | 0 {papers/doc => doc}/4-instrument/game-boy.md | 0 {papers/doc => doc}/4-instrument/list.png | Bin {papers/doc => doc}/4-instrument/lynx.md | 0 {papers/doc => doc}/4-instrument/macro.png | Bin {papers/doc => doc}/4-instrument/n163.md | 0 {papers/doc => doc}/4-instrument/pce.md | 0 {papers/doc => doc}/4-instrument/saa.md | 0 {papers/doc => doc}/4-instrument/scc.md | 0 {papers/doc => doc}/4-instrument/standard.md | 0 {papers/doc => doc}/4-instrument/tia.md | 0 {papers/doc => doc}/4-instrument/vera.md | 0 {papers/doc => doc}/4-instrument/vrc6.md | 0 {papers/doc => doc}/4-instrument/wonderswan.md | 0 {papers/doc => doc}/4-instrument/x1_010.md | 0 {papers/doc => doc}/5-wave/README.md | 0 {papers/doc => doc}/6-sample/README.md | 0 {papers/doc => doc}/7-systems/README.md | 0 {papers/doc => doc}/7-systems/amiga.md | 0 {papers/doc => doc}/7-systems/ay8910.md | 0 {papers/doc => doc}/7-systems/ay8930.md | 0 {papers/doc => doc}/7-systems/bubblesystem.md | 0 {papers/doc => doc}/7-systems/c64.md | 0 {papers/doc => doc}/7-systems/dac.md | 0 {papers/doc => doc}/7-systems/es5506.md | 0 {papers/doc => doc}/7-systems/fds.md | 0 {papers/doc => doc}/7-systems/game-boy.md | 0 {papers/doc => doc}/7-systems/genesis.md | 0 {papers/doc => doc}/7-systems/k007232.md | 0 {papers/doc => doc}/7-systems/lynx.md | 0 {papers/doc => doc}/7-systems/mmc5.md | 0 {papers/doc => doc}/7-systems/msm5232.md | 0 {papers/doc => doc}/7-systems/msm6258.md | 0 {papers/doc => doc}/7-systems/msm6295.md | 0 {papers/doc => doc}/7-systems/n163.md | 0 {papers/doc => doc}/7-systems/namco.md | 0 {papers/doc => doc}/7-systems/nes.md | 0 {papers/doc => doc}/7-systems/opl.md | 0 {papers/doc => doc}/7-systems/opll.md | 0 {papers/doc => doc}/7-systems/opz.md | 0 {papers/doc => doc}/7-systems/pce.md | 0 {papers/doc => doc}/7-systems/pcspkr.md | 0 {papers/doc => doc}/7-systems/pet.md | 0 {papers/doc => doc}/7-systems/pokey.md | 0 {papers/doc => doc}/7-systems/qsound.md | 0 {papers/doc => doc}/7-systems/ricoh.md | 0 {papers/doc => doc}/7-systems/saa1099.md | 0 {papers/doc => doc}/7-systems/scc.md | 0 {papers/doc => doc}/7-systems/segapcm.md | 0 {papers/doc => doc}/7-systems/sm8521.md | 0 {papers/doc => doc}/7-systems/sms.md | 0 {papers/doc => doc}/7-systems/snes.md | 0 {papers/doc => doc}/7-systems/soundunit.md | 0 {papers/doc => doc}/7-systems/t6w28.md | 0 {papers/doc => doc}/7-systems/tia.md | 0 {papers/doc => doc}/7-systems/vera.md | 0 {papers/doc => doc}/7-systems/vic20.md | 0 {papers/doc => doc}/7-systems/virtual-boy.md | 0 {papers/doc => doc}/7-systems/vrc6.md | 0 {papers/doc => doc}/7-systems/wonderswan.md | 0 {papers/doc => doc}/7-systems/x1-010.md | 0 {papers/doc => doc}/7-systems/ym2151.md | 0 {papers/doc => doc}/7-systems/ym2203.md | 0 {papers/doc => doc}/7-systems/ym2608.md | 0 {papers/doc => doc}/7-systems/ym2610.md | 0 {papers/doc => doc}/7-systems/ym2610b.md | 0 {papers/doc => doc}/7-systems/ym2612.md | 0 {papers/doc => doc}/7-systems/ymu759.md | 0 {papers/doc => doc}/7-systems/ymz280b.md | 0 {papers/doc => doc}/7-systems/zxbeep.md | 0 {papers/doc => doc}/8-advanced/README.md | 0 {papers/doc => doc}/8-advanced/channels.md | 0 {papers/doc => doc}/8-advanced/chanosc.md | 0 {papers/doc => doc}/8-advanced/chip-manager.md | 0 {papers/doc => doc}/8-advanced/clock.md | 0 {papers/doc => doc}/8-advanced/comments.md | 0 {papers/doc => doc}/8-advanced/compat-flags.md | 0 {papers/doc => doc}/8-advanced/grooves.md | 0 {papers/doc => doc}/8-advanced/log-viewer.md | 0 {papers/doc => doc}/8-advanced/mixer.md | 0 {papers/doc => doc}/8-advanced/osc.md | 0 {papers/doc => doc}/8-advanced/pat-manager.md | 0 {papers/doc => doc}/8-advanced/piano.md | 0 {papers/doc => doc}/8-advanced/regview.md | 0 {papers/doc => doc}/8-advanced/stats.md | 0 {papers/doc => doc}/README.md | 0 scripts/release-linux-AppImage.sh | 2 -- scripts/release-linux.sh | 1 + scripts/release-win32.sh | 3 ++- scripts/release-win64.sh | 3 ++- src/gui/image.cpp | 3 --- src/gui/tutorial.cpp | 2 +- 122 files changed, 15 insertions(+), 16 deletions(-) rename {papers/doc => doc}/1-intro/README.md (100%) rename {papers/doc => doc}/1-intro/hex.md (100%) rename {papers/doc => doc}/2-interface/README.md (100%) rename {papers/doc => doc}/2-interface/asset-list.md (100%) rename {papers/doc => doc}/2-interface/basic-mode.md (100%) rename {papers/doc => doc}/2-interface/components.md (100%) rename {papers/doc => doc}/2-interface/docking.png (100%) rename {papers/doc => doc}/2-interface/interface1.png (100%) rename {papers/doc => doc}/2-interface/keyboard.md (100%) rename {papers/doc => doc}/2-interface/menu-bar.md (100%) rename {papers/doc => doc}/2-interface/play-edit-controls.md (100%) rename {papers/doc => doc}/2-interface/song-info.md (100%) rename {papers/doc => doc}/2-interface/tab1.png (100%) rename {papers/doc => doc}/2-interface/tab2.png (100%) rename {papers/doc => doc}/2-interface/tab3.png (100%) rename {papers/doc => doc}/2-interface/window.png (100%) rename {papers/doc => doc}/3-pattern/README.md (100%) rename {papers/doc => doc}/3-pattern/channelbar.png (100%) rename {papers/doc => doc}/3-pattern/channels.png (100%) rename {papers/doc => doc}/3-pattern/effects.md (100%) rename {papers/doc => doc}/3-pattern/keyboard.png (100%) rename {papers/doc => doc}/3-pattern/pattern.png (100%) rename {papers/doc => doc}/4-instrument/8930.md (100%) rename {papers/doc => doc}/4-instrument/README.md (100%) rename {papers/doc => doc}/4-instrument/amiga.md (100%) rename {papers/doc => doc}/4-instrument/ay8910.md (100%) rename {papers/doc => doc}/4-instrument/c64.md (100%) rename {papers/doc => doc}/4-instrument/fm.md (100%) rename {papers/doc => doc}/4-instrument/game-boy.md (100%) rename {papers/doc => doc}/4-instrument/list.png (100%) rename {papers/doc => doc}/4-instrument/lynx.md (100%) rename {papers/doc => doc}/4-instrument/macro.png (100%) rename {papers/doc => doc}/4-instrument/n163.md (100%) rename {papers/doc => doc}/4-instrument/pce.md (100%) rename {papers/doc => doc}/4-instrument/saa.md (100%) rename {papers/doc => doc}/4-instrument/scc.md (100%) rename {papers/doc => doc}/4-instrument/standard.md (100%) rename {papers/doc => doc}/4-instrument/tia.md (100%) rename {papers/doc => doc}/4-instrument/vera.md (100%) rename {papers/doc => doc}/4-instrument/vrc6.md (100%) rename {papers/doc => doc}/4-instrument/wonderswan.md (100%) rename {papers/doc => doc}/4-instrument/x1_010.md (100%) rename {papers/doc => doc}/5-wave/README.md (100%) rename {papers/doc => doc}/6-sample/README.md (100%) rename {papers/doc => doc}/7-systems/README.md (100%) rename {papers/doc => doc}/7-systems/amiga.md (100%) rename {papers/doc => doc}/7-systems/ay8910.md (100%) rename {papers/doc => doc}/7-systems/ay8930.md (100%) rename {papers/doc => doc}/7-systems/bubblesystem.md (100%) rename {papers/doc => doc}/7-systems/c64.md (100%) rename {papers/doc => doc}/7-systems/dac.md (100%) rename {papers/doc => doc}/7-systems/es5506.md (100%) rename {papers/doc => doc}/7-systems/fds.md (100%) rename {papers/doc => doc}/7-systems/game-boy.md (100%) rename {papers/doc => doc}/7-systems/genesis.md (100%) rename {papers/doc => doc}/7-systems/k007232.md (100%) rename {papers/doc => doc}/7-systems/lynx.md (100%) rename {papers/doc => doc}/7-systems/mmc5.md (100%) rename {papers/doc => doc}/7-systems/msm5232.md (100%) rename {papers/doc => doc}/7-systems/msm6258.md (100%) rename {papers/doc => doc}/7-systems/msm6295.md (100%) rename {papers/doc => doc}/7-systems/n163.md (100%) rename {papers/doc => doc}/7-systems/namco.md (100%) rename {papers/doc => doc}/7-systems/nes.md (100%) rename {papers/doc => doc}/7-systems/opl.md (100%) rename {papers/doc => doc}/7-systems/opll.md (100%) rename {papers/doc => doc}/7-systems/opz.md (100%) rename {papers/doc => doc}/7-systems/pce.md (100%) rename {papers/doc => doc}/7-systems/pcspkr.md (100%) rename {papers/doc => doc}/7-systems/pet.md (100%) rename {papers/doc => doc}/7-systems/pokey.md (100%) rename {papers/doc => doc}/7-systems/qsound.md (100%) rename {papers/doc => doc}/7-systems/ricoh.md (100%) rename {papers/doc => doc}/7-systems/saa1099.md (100%) rename {papers/doc => doc}/7-systems/scc.md (100%) rename {papers/doc => doc}/7-systems/segapcm.md (100%) rename {papers/doc => doc}/7-systems/sm8521.md (100%) rename {papers/doc => doc}/7-systems/sms.md (100%) rename {papers/doc => doc}/7-systems/snes.md (100%) rename {papers/doc => doc}/7-systems/soundunit.md (100%) rename {papers/doc => doc}/7-systems/t6w28.md (100%) rename {papers/doc => doc}/7-systems/tia.md (100%) rename {papers/doc => doc}/7-systems/vera.md (100%) rename {papers/doc => doc}/7-systems/vic20.md (100%) rename {papers/doc => doc}/7-systems/virtual-boy.md (100%) rename {papers/doc => doc}/7-systems/vrc6.md (100%) rename {papers/doc => doc}/7-systems/wonderswan.md (100%) rename {papers/doc => doc}/7-systems/x1-010.md (100%) rename {papers/doc => doc}/7-systems/ym2151.md (100%) rename {papers/doc => doc}/7-systems/ym2203.md (100%) rename {papers/doc => doc}/7-systems/ym2608.md (100%) rename {papers/doc => doc}/7-systems/ym2610.md (100%) rename {papers/doc => doc}/7-systems/ym2610b.md (100%) rename {papers/doc => doc}/7-systems/ym2612.md (100%) rename {papers/doc => doc}/7-systems/ymu759.md (100%) rename {papers/doc => doc}/7-systems/ymz280b.md (100%) rename {papers/doc => doc}/7-systems/zxbeep.md (100%) rename {papers/doc => doc}/8-advanced/README.md (100%) rename {papers/doc => doc}/8-advanced/channels.md (100%) rename {papers/doc => doc}/8-advanced/chanosc.md (100%) rename {papers/doc => doc}/8-advanced/chip-manager.md (100%) rename {papers/doc => doc}/8-advanced/clock.md (100%) rename {papers/doc => doc}/8-advanced/comments.md (100%) rename {papers/doc => doc}/8-advanced/compat-flags.md (100%) rename {papers/doc => doc}/8-advanced/grooves.md (100%) rename {papers/doc => doc}/8-advanced/log-viewer.md (100%) rename {papers/doc => doc}/8-advanced/mixer.md (100%) rename {papers/doc => doc}/8-advanced/osc.md (100%) rename {papers/doc => doc}/8-advanced/pat-manager.md (100%) rename {papers/doc => doc}/8-advanced/piano.md (100%) rename {papers/doc => doc}/8-advanced/regview.md (100%) rename {papers/doc => doc}/8-advanced/stats.md (100%) rename {papers/doc => doc}/README.md (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index fd9be912..5e99a8dd 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -872,7 +872,8 @@ if (NOT ANDROID OR TERMUX) install(TARGETS furnace RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) install(FILES res/furnace.desktop DESTINATION ${CMAKE_INSTALL_DATADIR}/applications) install(FILES res/furnace.appdata.xml DESTINATION ${CMAKE_INSTALL_DATADIR}/metainfo) - install(DIRECTORY papers DESTINATION ${CMAKE_INSTALL_DOCDIR}) + install(DIRECTORY doc DESTINATION ${CMAKE_INSTALL_DOCDIR}) + install(DIRECTORY papers DESTINATION ${CMAKE_INSTALL_DOCDIR}/other) install(FILES LICENSE DESTINATION ${CMAKE_INSTALL_DATADIR}/licenses/furnace) if (WITH_DEMOS) install(DIRECTORY demos DESTINATION ${CMAKE_INSTALL_DATADIR}/furnace) diff --git a/README.md b/README.md index 7f2a34cf..4ecbd14c 100644 --- a/README.md +++ b/README.md @@ -120,7 +120,7 @@ check out the [Releases](https://github.com/tildearrow/furnace/releases) page. a # quick references - **discussion**: see the [Discussions](https://github.com/tildearrow/furnace/discussions) section, or the [official Discord server](https://discord.gg/EfrwT2wq7z). -- **help**: check out the [documentation](papers/doc/README.md). it's incomplete, but has details on effects. +- **help**: check out the [documentation](doc/README.md). it's incomplete though. ## packages @@ -301,7 +301,7 @@ you may need to log out and/or reboot after doing this. > where's the manual? -see [papers/](papers/doc/README.md). it's kind of incomplete, but at least the sound chips section is there. +see [doc/](doc/README.md). it's kind of incomplete though. > is there a tutorial? diff --git a/TODO.md b/TODO.md index 0b7f1cd9..4af99b6f 100644 --- a/TODO.md +++ b/TODO.md @@ -1,6 +1,6 @@ -# to-do for 0.6pre5 +# to-do for 0.6pre6 -- tutorial +- tutorial? - ease-of-use improvements... ideas: - preset compat flags - setting to toggle the Choose a System screen on new project @@ -8,9 +8,9 @@ - a more preferable highlight/drag system - some speed/intuitive workflow improvements that go a long way - Had a hard time finding the docs on github and in Furnace's folder. - - make .pdf manual out of papers/doc/ - - you're going too fast; please slow down - - break compatibility if it relieves complexity + - make .pdf manual out of doc/ + - you're going too slow; please run + - break compatibility if it relieves complexity - ins/wave/sample organization (folders and all) - multi-key binds - bug fixes diff --git a/papers/doc/1-intro/README.md b/doc/1-intro/README.md similarity index 100% rename from papers/doc/1-intro/README.md rename to doc/1-intro/README.md diff --git a/papers/doc/1-intro/hex.md b/doc/1-intro/hex.md similarity index 100% rename from papers/doc/1-intro/hex.md rename to doc/1-intro/hex.md diff --git a/papers/doc/2-interface/README.md b/doc/2-interface/README.md similarity index 100% rename from papers/doc/2-interface/README.md rename to doc/2-interface/README.md diff --git a/papers/doc/2-interface/asset-list.md b/doc/2-interface/asset-list.md similarity index 100% rename from papers/doc/2-interface/asset-list.md rename to doc/2-interface/asset-list.md diff --git a/papers/doc/2-interface/basic-mode.md b/doc/2-interface/basic-mode.md similarity index 100% rename from papers/doc/2-interface/basic-mode.md rename to doc/2-interface/basic-mode.md diff --git a/papers/doc/2-interface/components.md b/doc/2-interface/components.md similarity index 100% rename from papers/doc/2-interface/components.md rename to doc/2-interface/components.md diff --git a/papers/doc/2-interface/docking.png b/doc/2-interface/docking.png similarity index 100% rename from papers/doc/2-interface/docking.png rename to doc/2-interface/docking.png diff --git a/papers/doc/2-interface/interface1.png b/doc/2-interface/interface1.png similarity index 100% rename from papers/doc/2-interface/interface1.png rename to doc/2-interface/interface1.png diff --git a/papers/doc/2-interface/keyboard.md b/doc/2-interface/keyboard.md similarity index 100% rename from papers/doc/2-interface/keyboard.md rename to doc/2-interface/keyboard.md diff --git a/papers/doc/2-interface/menu-bar.md b/doc/2-interface/menu-bar.md similarity index 100% rename from papers/doc/2-interface/menu-bar.md rename to doc/2-interface/menu-bar.md diff --git a/papers/doc/2-interface/play-edit-controls.md b/doc/2-interface/play-edit-controls.md similarity index 100% rename from papers/doc/2-interface/play-edit-controls.md rename to doc/2-interface/play-edit-controls.md diff --git a/papers/doc/2-interface/song-info.md b/doc/2-interface/song-info.md similarity index 100% rename from papers/doc/2-interface/song-info.md rename to doc/2-interface/song-info.md diff --git a/papers/doc/2-interface/tab1.png b/doc/2-interface/tab1.png similarity index 100% rename from papers/doc/2-interface/tab1.png rename to doc/2-interface/tab1.png diff --git a/papers/doc/2-interface/tab2.png b/doc/2-interface/tab2.png similarity index 100% rename from papers/doc/2-interface/tab2.png rename to doc/2-interface/tab2.png diff --git a/papers/doc/2-interface/tab3.png b/doc/2-interface/tab3.png similarity index 100% rename from papers/doc/2-interface/tab3.png rename to doc/2-interface/tab3.png diff --git a/papers/doc/2-interface/window.png b/doc/2-interface/window.png similarity index 100% rename from papers/doc/2-interface/window.png rename to doc/2-interface/window.png diff --git a/papers/doc/3-pattern/README.md b/doc/3-pattern/README.md similarity index 100% rename from papers/doc/3-pattern/README.md rename to doc/3-pattern/README.md diff --git a/papers/doc/3-pattern/channelbar.png b/doc/3-pattern/channelbar.png similarity index 100% rename from papers/doc/3-pattern/channelbar.png rename to doc/3-pattern/channelbar.png diff --git a/papers/doc/3-pattern/channels.png b/doc/3-pattern/channels.png similarity index 100% rename from papers/doc/3-pattern/channels.png rename to doc/3-pattern/channels.png diff --git a/papers/doc/3-pattern/effects.md b/doc/3-pattern/effects.md similarity index 100% rename from papers/doc/3-pattern/effects.md rename to doc/3-pattern/effects.md diff --git a/papers/doc/3-pattern/keyboard.png b/doc/3-pattern/keyboard.png similarity index 100% rename from papers/doc/3-pattern/keyboard.png rename to doc/3-pattern/keyboard.png diff --git a/papers/doc/3-pattern/pattern.png b/doc/3-pattern/pattern.png similarity index 100% rename from papers/doc/3-pattern/pattern.png rename to doc/3-pattern/pattern.png diff --git a/papers/doc/4-instrument/8930.md b/doc/4-instrument/8930.md similarity index 100% rename from papers/doc/4-instrument/8930.md rename to doc/4-instrument/8930.md diff --git a/papers/doc/4-instrument/README.md b/doc/4-instrument/README.md similarity index 100% rename from papers/doc/4-instrument/README.md rename to doc/4-instrument/README.md diff --git a/papers/doc/4-instrument/amiga.md b/doc/4-instrument/amiga.md similarity index 100% rename from papers/doc/4-instrument/amiga.md rename to doc/4-instrument/amiga.md diff --git a/papers/doc/4-instrument/ay8910.md b/doc/4-instrument/ay8910.md similarity index 100% rename from papers/doc/4-instrument/ay8910.md rename to doc/4-instrument/ay8910.md diff --git a/papers/doc/4-instrument/c64.md b/doc/4-instrument/c64.md similarity index 100% rename from papers/doc/4-instrument/c64.md rename to doc/4-instrument/c64.md diff --git a/papers/doc/4-instrument/fm.md b/doc/4-instrument/fm.md similarity index 100% rename from papers/doc/4-instrument/fm.md rename to doc/4-instrument/fm.md diff --git a/papers/doc/4-instrument/game-boy.md b/doc/4-instrument/game-boy.md similarity index 100% rename from papers/doc/4-instrument/game-boy.md rename to doc/4-instrument/game-boy.md diff --git a/papers/doc/4-instrument/list.png b/doc/4-instrument/list.png similarity index 100% rename from papers/doc/4-instrument/list.png rename to doc/4-instrument/list.png diff --git a/papers/doc/4-instrument/lynx.md b/doc/4-instrument/lynx.md similarity index 100% rename from papers/doc/4-instrument/lynx.md rename to doc/4-instrument/lynx.md diff --git a/papers/doc/4-instrument/macro.png b/doc/4-instrument/macro.png similarity index 100% rename from papers/doc/4-instrument/macro.png rename to doc/4-instrument/macro.png diff --git a/papers/doc/4-instrument/n163.md b/doc/4-instrument/n163.md similarity index 100% rename from papers/doc/4-instrument/n163.md rename to doc/4-instrument/n163.md diff --git a/papers/doc/4-instrument/pce.md b/doc/4-instrument/pce.md similarity index 100% rename from papers/doc/4-instrument/pce.md rename to doc/4-instrument/pce.md diff --git a/papers/doc/4-instrument/saa.md b/doc/4-instrument/saa.md similarity index 100% rename from papers/doc/4-instrument/saa.md rename to doc/4-instrument/saa.md diff --git a/papers/doc/4-instrument/scc.md b/doc/4-instrument/scc.md similarity index 100% rename from papers/doc/4-instrument/scc.md rename to doc/4-instrument/scc.md diff --git a/papers/doc/4-instrument/standard.md b/doc/4-instrument/standard.md similarity index 100% rename from papers/doc/4-instrument/standard.md rename to doc/4-instrument/standard.md diff --git a/papers/doc/4-instrument/tia.md b/doc/4-instrument/tia.md similarity index 100% rename from papers/doc/4-instrument/tia.md rename to doc/4-instrument/tia.md diff --git a/papers/doc/4-instrument/vera.md b/doc/4-instrument/vera.md similarity index 100% rename from papers/doc/4-instrument/vera.md rename to doc/4-instrument/vera.md diff --git a/papers/doc/4-instrument/vrc6.md b/doc/4-instrument/vrc6.md similarity index 100% rename from papers/doc/4-instrument/vrc6.md rename to doc/4-instrument/vrc6.md diff --git a/papers/doc/4-instrument/wonderswan.md b/doc/4-instrument/wonderswan.md similarity index 100% rename from papers/doc/4-instrument/wonderswan.md rename to doc/4-instrument/wonderswan.md diff --git a/papers/doc/4-instrument/x1_010.md b/doc/4-instrument/x1_010.md similarity index 100% rename from papers/doc/4-instrument/x1_010.md rename to doc/4-instrument/x1_010.md diff --git a/papers/doc/5-wave/README.md b/doc/5-wave/README.md similarity index 100% rename from papers/doc/5-wave/README.md rename to doc/5-wave/README.md diff --git a/papers/doc/6-sample/README.md b/doc/6-sample/README.md similarity index 100% rename from papers/doc/6-sample/README.md rename to doc/6-sample/README.md diff --git a/papers/doc/7-systems/README.md b/doc/7-systems/README.md similarity index 100% rename from papers/doc/7-systems/README.md rename to doc/7-systems/README.md diff --git a/papers/doc/7-systems/amiga.md b/doc/7-systems/amiga.md similarity index 100% rename from papers/doc/7-systems/amiga.md rename to doc/7-systems/amiga.md diff --git a/papers/doc/7-systems/ay8910.md b/doc/7-systems/ay8910.md similarity index 100% rename from papers/doc/7-systems/ay8910.md rename to doc/7-systems/ay8910.md diff --git a/papers/doc/7-systems/ay8930.md b/doc/7-systems/ay8930.md similarity index 100% rename from papers/doc/7-systems/ay8930.md rename to doc/7-systems/ay8930.md diff --git a/papers/doc/7-systems/bubblesystem.md b/doc/7-systems/bubblesystem.md similarity index 100% rename from papers/doc/7-systems/bubblesystem.md rename to doc/7-systems/bubblesystem.md diff --git a/papers/doc/7-systems/c64.md b/doc/7-systems/c64.md similarity index 100% rename from papers/doc/7-systems/c64.md rename to doc/7-systems/c64.md diff --git a/papers/doc/7-systems/dac.md b/doc/7-systems/dac.md similarity index 100% rename from papers/doc/7-systems/dac.md rename to doc/7-systems/dac.md diff --git a/papers/doc/7-systems/es5506.md b/doc/7-systems/es5506.md similarity index 100% rename from papers/doc/7-systems/es5506.md rename to doc/7-systems/es5506.md diff --git a/papers/doc/7-systems/fds.md b/doc/7-systems/fds.md similarity index 100% rename from papers/doc/7-systems/fds.md rename to doc/7-systems/fds.md diff --git a/papers/doc/7-systems/game-boy.md b/doc/7-systems/game-boy.md similarity index 100% rename from papers/doc/7-systems/game-boy.md rename to doc/7-systems/game-boy.md diff --git a/papers/doc/7-systems/genesis.md b/doc/7-systems/genesis.md similarity index 100% rename from papers/doc/7-systems/genesis.md rename to doc/7-systems/genesis.md diff --git a/papers/doc/7-systems/k007232.md b/doc/7-systems/k007232.md similarity index 100% rename from papers/doc/7-systems/k007232.md rename to doc/7-systems/k007232.md diff --git a/papers/doc/7-systems/lynx.md b/doc/7-systems/lynx.md similarity index 100% rename from papers/doc/7-systems/lynx.md rename to doc/7-systems/lynx.md diff --git a/papers/doc/7-systems/mmc5.md b/doc/7-systems/mmc5.md similarity index 100% rename from papers/doc/7-systems/mmc5.md rename to doc/7-systems/mmc5.md diff --git a/papers/doc/7-systems/msm5232.md b/doc/7-systems/msm5232.md similarity index 100% rename from papers/doc/7-systems/msm5232.md rename to doc/7-systems/msm5232.md diff --git a/papers/doc/7-systems/msm6258.md b/doc/7-systems/msm6258.md similarity index 100% rename from papers/doc/7-systems/msm6258.md rename to doc/7-systems/msm6258.md diff --git a/papers/doc/7-systems/msm6295.md b/doc/7-systems/msm6295.md similarity index 100% rename from papers/doc/7-systems/msm6295.md rename to doc/7-systems/msm6295.md diff --git a/papers/doc/7-systems/n163.md b/doc/7-systems/n163.md similarity index 100% rename from papers/doc/7-systems/n163.md rename to doc/7-systems/n163.md diff --git a/papers/doc/7-systems/namco.md b/doc/7-systems/namco.md similarity index 100% rename from papers/doc/7-systems/namco.md rename to doc/7-systems/namco.md diff --git a/papers/doc/7-systems/nes.md b/doc/7-systems/nes.md similarity index 100% rename from papers/doc/7-systems/nes.md rename to doc/7-systems/nes.md diff --git a/papers/doc/7-systems/opl.md b/doc/7-systems/opl.md similarity index 100% rename from papers/doc/7-systems/opl.md rename to doc/7-systems/opl.md diff --git a/papers/doc/7-systems/opll.md b/doc/7-systems/opll.md similarity index 100% rename from papers/doc/7-systems/opll.md rename to doc/7-systems/opll.md diff --git a/papers/doc/7-systems/opz.md b/doc/7-systems/opz.md similarity index 100% rename from papers/doc/7-systems/opz.md rename to doc/7-systems/opz.md diff --git a/papers/doc/7-systems/pce.md b/doc/7-systems/pce.md similarity index 100% rename from papers/doc/7-systems/pce.md rename to doc/7-systems/pce.md diff --git a/papers/doc/7-systems/pcspkr.md b/doc/7-systems/pcspkr.md similarity index 100% rename from papers/doc/7-systems/pcspkr.md rename to doc/7-systems/pcspkr.md diff --git a/papers/doc/7-systems/pet.md b/doc/7-systems/pet.md similarity index 100% rename from papers/doc/7-systems/pet.md rename to doc/7-systems/pet.md diff --git a/papers/doc/7-systems/pokey.md b/doc/7-systems/pokey.md similarity index 100% rename from papers/doc/7-systems/pokey.md rename to doc/7-systems/pokey.md diff --git a/papers/doc/7-systems/qsound.md b/doc/7-systems/qsound.md similarity index 100% rename from papers/doc/7-systems/qsound.md rename to doc/7-systems/qsound.md diff --git a/papers/doc/7-systems/ricoh.md b/doc/7-systems/ricoh.md similarity index 100% rename from papers/doc/7-systems/ricoh.md rename to doc/7-systems/ricoh.md diff --git a/papers/doc/7-systems/saa1099.md b/doc/7-systems/saa1099.md similarity index 100% rename from papers/doc/7-systems/saa1099.md rename to doc/7-systems/saa1099.md diff --git a/papers/doc/7-systems/scc.md b/doc/7-systems/scc.md similarity index 100% rename from papers/doc/7-systems/scc.md rename to doc/7-systems/scc.md diff --git a/papers/doc/7-systems/segapcm.md b/doc/7-systems/segapcm.md similarity index 100% rename from papers/doc/7-systems/segapcm.md rename to doc/7-systems/segapcm.md diff --git a/papers/doc/7-systems/sm8521.md b/doc/7-systems/sm8521.md similarity index 100% rename from papers/doc/7-systems/sm8521.md rename to doc/7-systems/sm8521.md diff --git a/papers/doc/7-systems/sms.md b/doc/7-systems/sms.md similarity index 100% rename from papers/doc/7-systems/sms.md rename to doc/7-systems/sms.md diff --git a/papers/doc/7-systems/snes.md b/doc/7-systems/snes.md similarity index 100% rename from papers/doc/7-systems/snes.md rename to doc/7-systems/snes.md diff --git a/papers/doc/7-systems/soundunit.md b/doc/7-systems/soundunit.md similarity index 100% rename from papers/doc/7-systems/soundunit.md rename to doc/7-systems/soundunit.md diff --git a/papers/doc/7-systems/t6w28.md b/doc/7-systems/t6w28.md similarity index 100% rename from papers/doc/7-systems/t6w28.md rename to doc/7-systems/t6w28.md diff --git a/papers/doc/7-systems/tia.md b/doc/7-systems/tia.md similarity index 100% rename from papers/doc/7-systems/tia.md rename to doc/7-systems/tia.md diff --git a/papers/doc/7-systems/vera.md b/doc/7-systems/vera.md similarity index 100% rename from papers/doc/7-systems/vera.md rename to doc/7-systems/vera.md diff --git a/papers/doc/7-systems/vic20.md b/doc/7-systems/vic20.md similarity index 100% rename from papers/doc/7-systems/vic20.md rename to doc/7-systems/vic20.md diff --git a/papers/doc/7-systems/virtual-boy.md b/doc/7-systems/virtual-boy.md similarity index 100% rename from papers/doc/7-systems/virtual-boy.md rename to doc/7-systems/virtual-boy.md diff --git a/papers/doc/7-systems/vrc6.md b/doc/7-systems/vrc6.md similarity index 100% rename from papers/doc/7-systems/vrc6.md rename to doc/7-systems/vrc6.md diff --git a/papers/doc/7-systems/wonderswan.md b/doc/7-systems/wonderswan.md similarity index 100% rename from papers/doc/7-systems/wonderswan.md rename to doc/7-systems/wonderswan.md diff --git a/papers/doc/7-systems/x1-010.md b/doc/7-systems/x1-010.md similarity index 100% rename from papers/doc/7-systems/x1-010.md rename to doc/7-systems/x1-010.md diff --git a/papers/doc/7-systems/ym2151.md b/doc/7-systems/ym2151.md similarity index 100% rename from papers/doc/7-systems/ym2151.md rename to doc/7-systems/ym2151.md diff --git a/papers/doc/7-systems/ym2203.md b/doc/7-systems/ym2203.md similarity index 100% rename from papers/doc/7-systems/ym2203.md rename to doc/7-systems/ym2203.md diff --git a/papers/doc/7-systems/ym2608.md b/doc/7-systems/ym2608.md similarity index 100% rename from papers/doc/7-systems/ym2608.md rename to doc/7-systems/ym2608.md diff --git a/papers/doc/7-systems/ym2610.md b/doc/7-systems/ym2610.md similarity index 100% rename from papers/doc/7-systems/ym2610.md rename to doc/7-systems/ym2610.md diff --git a/papers/doc/7-systems/ym2610b.md b/doc/7-systems/ym2610b.md similarity index 100% rename from papers/doc/7-systems/ym2610b.md rename to doc/7-systems/ym2610b.md diff --git a/papers/doc/7-systems/ym2612.md b/doc/7-systems/ym2612.md similarity index 100% rename from papers/doc/7-systems/ym2612.md rename to doc/7-systems/ym2612.md diff --git a/papers/doc/7-systems/ymu759.md b/doc/7-systems/ymu759.md similarity index 100% rename from papers/doc/7-systems/ymu759.md rename to doc/7-systems/ymu759.md diff --git a/papers/doc/7-systems/ymz280b.md b/doc/7-systems/ymz280b.md similarity index 100% rename from papers/doc/7-systems/ymz280b.md rename to doc/7-systems/ymz280b.md diff --git a/papers/doc/7-systems/zxbeep.md b/doc/7-systems/zxbeep.md similarity index 100% rename from papers/doc/7-systems/zxbeep.md rename to doc/7-systems/zxbeep.md diff --git a/papers/doc/8-advanced/README.md b/doc/8-advanced/README.md similarity index 100% rename from papers/doc/8-advanced/README.md rename to doc/8-advanced/README.md diff --git a/papers/doc/8-advanced/channels.md b/doc/8-advanced/channels.md similarity index 100% rename from papers/doc/8-advanced/channels.md rename to doc/8-advanced/channels.md diff --git a/papers/doc/8-advanced/chanosc.md b/doc/8-advanced/chanosc.md similarity index 100% rename from papers/doc/8-advanced/chanosc.md rename to doc/8-advanced/chanosc.md diff --git a/papers/doc/8-advanced/chip-manager.md b/doc/8-advanced/chip-manager.md similarity index 100% rename from papers/doc/8-advanced/chip-manager.md rename to doc/8-advanced/chip-manager.md diff --git a/papers/doc/8-advanced/clock.md b/doc/8-advanced/clock.md similarity index 100% rename from papers/doc/8-advanced/clock.md rename to doc/8-advanced/clock.md diff --git a/papers/doc/8-advanced/comments.md b/doc/8-advanced/comments.md similarity index 100% rename from papers/doc/8-advanced/comments.md rename to doc/8-advanced/comments.md diff --git a/papers/doc/8-advanced/compat-flags.md b/doc/8-advanced/compat-flags.md similarity index 100% rename from papers/doc/8-advanced/compat-flags.md rename to doc/8-advanced/compat-flags.md diff --git a/papers/doc/8-advanced/grooves.md b/doc/8-advanced/grooves.md similarity index 100% rename from papers/doc/8-advanced/grooves.md rename to doc/8-advanced/grooves.md diff --git a/papers/doc/8-advanced/log-viewer.md b/doc/8-advanced/log-viewer.md similarity index 100% rename from papers/doc/8-advanced/log-viewer.md rename to doc/8-advanced/log-viewer.md diff --git a/papers/doc/8-advanced/mixer.md b/doc/8-advanced/mixer.md similarity index 100% rename from papers/doc/8-advanced/mixer.md rename to doc/8-advanced/mixer.md diff --git a/papers/doc/8-advanced/osc.md b/doc/8-advanced/osc.md similarity index 100% rename from papers/doc/8-advanced/osc.md rename to doc/8-advanced/osc.md diff --git a/papers/doc/8-advanced/pat-manager.md b/doc/8-advanced/pat-manager.md similarity index 100% rename from papers/doc/8-advanced/pat-manager.md rename to doc/8-advanced/pat-manager.md diff --git a/papers/doc/8-advanced/piano.md b/doc/8-advanced/piano.md similarity index 100% rename from papers/doc/8-advanced/piano.md rename to doc/8-advanced/piano.md diff --git a/papers/doc/8-advanced/regview.md b/doc/8-advanced/regview.md similarity index 100% rename from papers/doc/8-advanced/regview.md rename to doc/8-advanced/regview.md diff --git a/papers/doc/8-advanced/stats.md b/doc/8-advanced/stats.md similarity index 100% rename from papers/doc/8-advanced/stats.md rename to doc/8-advanced/stats.md diff --git a/papers/doc/README.md b/doc/README.md similarity index 100% rename from papers/doc/README.md rename to doc/README.md diff --git a/scripts/release-linux-AppImage.sh b/scripts/release-linux-AppImage.sh index 7c20476f..4cf8a8cd 100755 --- a/scripts/release-linux-AppImage.sh +++ b/scripts/release-linux-AppImage.sh @@ -47,5 +47,3 @@ cd ../../.. [ -e appimagetool-x86_64.AppImage ] || { wget "https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage" && chmod 755 appimagetool-x86_64.AppImage; } ./appimagetool-x86_64.AppImage --appimage-extract ARCH=$(uname -m) ./squashfs-root/AppRun furnace.AppDir - -#zip -r furnace.zip LICENSE.txt Furnace*.dmg README.txt papers diff --git a/scripts/release-linux.sh b/scripts/release-linux.sh index b554ed70..030f8259 100755 --- a/scripts/release-linux.sh +++ b/scripts/release-linux.sh @@ -51,6 +51,7 @@ cd .. cp ../../../LICENSE . || exit 1 cp ../../../README.md . || exit 1 cp -r ../../../papers papers || exit 1 +cp -r ../../../doc doc || exit 1 rmdir usr || exit 1 strip -s furnace diff --git a/scripts/release-win32.sh b/scripts/release-win32.sh index df603dba..e0c0eec6 100755 --- a/scripts/release-win32.sh +++ b/scripts/release-win32.sh @@ -27,13 +27,14 @@ cp ../../LICENSE LICENSE.txt || exit 1 cp ../../win32build/furnace.exe . || exit 1 cp ../../README.md README.txt || exit 1 cp -r ../../papers papers || exit 1 +cp -r ../../doc doc || exit 1 cp -r ../../demos demos || exit 1 cp -r ../../instruments instruments || exit 1 cp -r ../../wavetables wavetables || exit 1 i686-w64-mingw32-strip -s furnace.exe || exit 1 -zip -r furnace.zip LICENSE.txt furnace.exe README.txt papers demos instruments wavetables +zip -r furnace.zip LICENSE.txt furnace.exe README.txt papers doc demos instruments wavetables furName=$(git describe --tags | sed "s/v0/0/") diff --git a/scripts/release-win64.sh b/scripts/release-win64.sh index e1678eda..9183007b 100755 --- a/scripts/release-win64.sh +++ b/scripts/release-win64.sh @@ -27,13 +27,14 @@ cp ../../LICENSE LICENSE.txt || exit 1 cp ../../winbuild/furnace.exe . || exit 1 cp ../../README.md README.txt || exit 1 cp -r ../../papers papers || exit 1 +cp -r ../../doc doc || exit 1 cp -r ../../demos demos || exit 1 cp -r ../../instruments instruments || exit 1 cp -r ../../wavetables wavetables || exit 1 x86_64-w64-mingw32-strip -s furnace.exe || exit 1 -zip -r furnace.zip LICENSE.txt furnace.exe README.txt papers demos instruments wavetables +zip -r furnace.zip LICENSE.txt furnace.exe README.txt papers doc demos instruments wavetables furName=$(git describe --tags | sed "s/v0/0/") diff --git a/src/gui/image.cpp b/src/gui/image.cpp index a075d8ac..c4528445 100644 --- a/src/gui/image.cpp +++ b/src/gui/image.cpp @@ -15,9 +15,6 @@ * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - * - * this license only applies to the code. for the license of each font used, - * see `papers/`. */ #include "gui.h" diff --git a/src/gui/tutorial.cpp b/src/gui/tutorial.cpp index 71ad3ca4..c1be8912 100644 --- a/src/gui/tutorial.cpp +++ b/src/gui/tutorial.cpp @@ -279,7 +279,7 @@ void FurnaceGUI::drawTutorial() { ImGui::TextWrapped( "if you need help, you may:\n" - "- read the (incomplete) manual: https://github.com/tildearrow/furnace/blob/master/papers/doc/README.md\n" + "- read the (incomplete) manual: https://github.com/tildearrow/furnace/blob/master/doc/README.md\n" "- ask for help in Discussions (https://github.com/tildearrow/furnace/discussions) or the Furnace Discord (https://discord.gg/EfrwT2wq7z)" );