Merge pull request #238 from Dn-Programming-Core-Management/version-i…

…ncremement

Begin to integrate markdown-based documentation

.github/workflows/build-artifact.yml

@@ -12,7 +12,11 @@ jobs:
     steps:
       - uses: actions/checkout@master
         with:
+          submodules: "recursive"
           fetch-depth: 0
+      - uses: r-lib/actions/setup-pandoc@v2
+        with:
+          pandoc-version: '3.1.8'
       - name: Set commit hash variable
         shell: powershell
         run: echo "commithash=$(git describe --tags)" >> $env:GITHUB_ENV

.github/workflows/build-release-artifact.yml

@@ -12,6 +12,12 @@ jobs:
         # configuration is Release only
     steps:
       - uses: actions/checkout@master
+        with:
+          submodules: "recursive"
+          fetch-depth: 0
+      - uses: r-lib/actions/setup-pandoc@v2
+        with:
+          pandoc-version: '3.1.8'
       - name: Build program
         shell: cmd
         run: |

.gitignore

@@ -37,6 +37,9 @@ Testing/Temporary
 
 distribute/*
 
+# ignore submodules
+Dn-help/*
+
 # this should be automatically generated at build
 hlp/HTMLDefines.h
 

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Dn-help"]
+	path = Dn-help
+	url = https://github.com/Dn-Programming-Core-Management/Dn-help.git

Dn-FamiTracker.sln

@@ -7,7 +7,7 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "Dn-FamiTracker", "Dn-FamiTr
 		{5B4C1AA7-4AE9-4FF2-A7E6-8EEE50EDC6E2} = {5B4C1AA7-4AE9-4FF2-A7E6-8EEE50EDC6E2}
 	EndProjectSection
 EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "hlp", "hlp\hlp.vcxproj", "{AFD2F6E3-E658-4A1B-A691-8F10A858321B}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "hlp", "Dn-help\hlp\hlp.vcxproj", "{AFD2F6E3-E658-4A1B-A691-8F10A858321B}"
 	ProjectSection(ProjectDependencies) = postProject
 		{92FE0690-CE4F-4CCF-A52C-23265AE7429F} = {92FE0690-CE4F-4CCF-A52C-23265AE7429F}
 	EndProjectSection

Dn_main_appveyor.yml

@@ -16,6 +16,17 @@ configuration:
 - ASAN-Release
 - ASAN-Debug
 shallow_clone: false
+cache:
+  - C:\RLibrary
+  - C:\Program Files (x86)\Pandoc\
+install:
+  - ps: >-
+      if (-Not (Test-Path "C:\Program Files (x86)\Pandoc\")) {
+        cinst pandoc
+      }
+  - ps: $env:Path += ";C:\Program Files (x86)\Pandoc\"
+  - pandoc -v
+  - git submodule update --init --recursive
 build:
   project: Dn-FamiTracker.sln
   parallel: true

README.md

@@ -10,7 +10,7 @@ Dn-Famitracker is a fork of 0CC-FamiTracker that incorporates numerous fixes and
 - More accessible VRC7 envelope editing
 - Improved FDS, N163 VRC7 and 2A03 emulation
 - Restored Help manual, now under maintenance at [Dn-help](https://github.com/Dn-Programming-Core-Management/Dn-help)
-- and more to come, see the [release page](https://github.com/Dn-Programming-Core-Management/Dn-FamiTracker/releases) for more info
+- and more to come, see the [release page](https://github.com/Dn-Programming-Core-Management/Dn-FamiTracker/releases) and the [changelog](docs/CHANGELOG.md) for more info
 
 ## Contributing
 

changelog.txt

@@ -1,3 +1,6 @@
+Notice: changelog.txt will no longer be maintained as of 10/23/2023.
+For further changelog updates, please go to docs/CHANGELOG.md
+
 Dn-FamiTracker Mod
 Change Log
 Written by Persune

cmake/compile-chm.bat

@@ -1,27 +1,28 @@
 rem call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" x86_amd64
 @echo off
-echo // Generated Help Map file.  Used by Dn-FamiTracker.hhp. > "hlp\HTMLDefines.h"
-echo. > "hlp\HTMLDefines.h"
-echo // Commands (ID_* and IDM_*) >> "hlp\HTMLDefines.h"
-makehm /h ID_,HID_,0x10000 IDM_,HIDM_,0x10000 "resource.h" >> "hlp\HTMLDefines.h"
-echo. >> "hlp\HTMLDefines.h"
-echo // Prompts (IDP_*) >> "hlp\HTMLDefines.h"
-makehm /h IDP_,HIDP_,0x30000 "resource.h" >> "hlp\HTMLDefines.h"
-echo. >> "hlp\HTMLDefines.h"
-echo // Resources (IDR_*) >> "hlp\HTMLDefines.h"
-makehm /h IDR_,HIDR_,0x20000 "resource.h" >> "hlp\HTMLDefines.h"
-echo. >> "hlp\HTMLDefines.h"
-echo // Dialogs (IDD_*) >> "hlp\HTMLDefines.h"
-makehm /h IDD_,HIDD_,0x20000 "resource.h" >> "hlp\HTMLDefines.h"
-echo. >> "hlp\HTMLDefines.h"
-echo // Frame Controls (IDW_*) >> "hlp\HTMLDefines.h"
-makehm /h /a "afxhh.h" IDW_,HIDW_,0x50000 "resource.h" >> "hlp\HTMLDefines.h"
-start /wait hhc "hlp\Dn-FamiTracker.hhp"
-if not exist "hlp\Dn-FamiTracker.chm" goto :HelpError
-move "hlp\Dn-FamiTracker.chm" "Dn-FamiTracker.chm"
+powershell -Command "(Get-Content Dn-help\hlp\changelog_shell.htm).Replace('<!-- INSERT-CHANGELOG-HERE -->', (pandoc docs/CHANGELOG.md -f gfm -t html5)) | Set-Content -encoding UTF8 Dn-help\hlp\changelog.htm"
+echo // Generated Help Map file.  Used by Dn-FamiTracker.hhp. > "Dn-help\hlp\HTMLDefines.h"
+echo. > "Dn-help\hlp\HTMLDefines.h"
+echo // Commands (ID_* and IDM_*) >> "Dn-help\hlp\HTMLDefines.h"
+makehm /h ID_,HID_,0x10000 IDM_,HIDM_,0x10000 "resource.h" >> "Dn-help\hlp\HTMLDefines.h"
+echo. >> "Dn-help\hlp\HTMLDefines.h"
+echo // Prompts (IDP_*) >> "Dn-help\hlp\HTMLDefines.h"
+makehm /h IDP_,HIDP_,0x30000 "resource.h" >> "Dn-help\hlp\HTMLDefines.h"
+echo. >> "Dn-help\hlp\HTMLDefines.h"
+echo // Resources (IDR_*) >> "Dn-help\hlp\HTMLDefines.h"
+makehm /h IDR_,HIDR_,0x20000 "resource.h" >> "Dn-help\hlp\HTMLDefines.h"
+echo. >> "Dn-help\hlp\HTMLDefines.h"
+echo // Dialogs (IDD_*) >> "Dn-help\hlp\HTMLDefines.h"
+makehm /h IDD_,HIDD_,0x20000 "resource.h" >> "Dn-help\hlp\HTMLDefines.h"
+echo. >> "Dn-help\hlp\HTMLDefines.h"
+echo // Frame Controls (IDW_*) >> "Dn-help\hlp\HTMLDefines.h"
+makehm /h /a "afxhh.h" IDW_,HIDW_,0x50000 "resource.h" >> "Dn-help\hlp\HTMLDefines.h"
+start /wait hhc "Dn-help\hlp\Dn-FamiTracker.hhp"
+if not exist "Dn-help\hlp\Dn-FamiTracker.chm" goto :HelpError
+move "Dn-help\hlp\Dn-FamiTracker.chm" "Dn-FamiTracker.chm"
 goto :HelpDone
 :HelpError
-echo hlp\Dn-FamiTracker.hhp(1) : error:Problem encountered creating help file
+echo Dn-help\hlp\Dn-FamiTracker.hhp(1) : error:Problem encountered creating help file
 echo.
 :HelpDone
 echo.