diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 2646eb8d4..573be180f 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -271,7 +271,7 @@ jobs: pushd ${{ steps.package-identify.outputs.filename }} cp -v ../LICENSE LICENSE.txt - cp -v ../README.md README.txt + cp -v ../res/releaseReadme/unstable-win.txt README.txt cp -vr ../papers ../${binPath}/furnace.exe ./ if [ '${{ matrix.config.compiler }}' == 'msvc' ]; then cp -v ../${binPath}/furnace.pdb ./ @@ -285,7 +285,29 @@ jobs: run: | pushd build cpack - mv Furnace-*-Darwin.dmg ../${{ steps.package-identify.outputs.filename }} + + mkdir orig + mkdir new + hdiutil attach Furnace-*-Darwin.dmg -readonly -mount required -mountpoint orig + + cp -r orig new + hdiutil detach orig + + rmdir orig + rm Furnace-*-Darwin.dmg + + cp -v ../LICENSE new/LICENSE.txt + cp -v ../res/releaseReadme/stable-mac.txt new/README + cp -v -r ../demos new/demos + cp -v -r ../instruments new/instruments + cp -v -r ../wavetables new/wavetables + cd new + wget https://tildearrow.org/furproto/manual.pdf + cd .. + + hdiutil create -srcfolder new -volname Furnace -format UDZO furnace.dmg + + mv furnace.dmg ../${{ steps.package-identify.outputs.filename }} popd - name: Package [Linux] @@ -317,7 +339,7 @@ jobs: cd .. cp ../../LICENSE . - cp ../../README.md . + cp ../../res/releaseReadme/unstable-other.txt . cp -r ../../papers papers rmdir usr diff --git a/res/releaseReadme/stable-linux.txt b/res/releaseReadme/stable-linux.txt index 3eb6e77d9..979720a83 100644 --- a/res/releaseReadme/stable-linux.txt +++ b/res/releaseReadme/stable-linux.txt @@ -1,5 +1,35 @@ # Furnace (chiptune tracker) -thank you for downloading Furnace! I hope you enjoy using it. +thank you for acquiring Furnace! I hope you enjoy using it. extract this archive, and run `furnace` to get started. + +# help + +some technical computing background is recommended for the best experience. +be sure to read the `manual.pdf` file for information on how to use this program. + +if you find issues (e.g. bugs or annoyances), report them. links below. + +# links + +- Furnace on GitHub (project page and issue tracker): https://github.com/tildearrow/furnace + - issues: https://github.com/tildearrow/furnace/issues + - discussion: https://github.com/tildearrow/furnace/discussions +- Furnace on Revolt: https://rvlt.gg/GRPS6tmc +- Furnace on Discord: https://discord.gg/EfrwT2wq7z +- online manual: https://tildearrow.org/furnace/doc/v0.6/ + +# notes + +copyright (C) 2021-2023 tildearrow and contributors. + +This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +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. + + +Furnace is NOT affiliated with Delek or DefleMask in any form, regardless of its ability to load and save the .dmf, .dmp and .dmw file formats. +additionally, Furnace does not intend to replace DefleMask, nor any other program. diff --git a/res/releaseReadme/stable-mac.txt b/res/releaseReadme/stable-mac.txt index fb84fb870..d2a50cd89 100644 --- a/res/releaseReadme/stable-mac.txt +++ b/res/releaseReadme/stable-mac.txt @@ -1,8 +1,9 @@ # Furnace (chiptune tracker) -thank you for downloading Furnace! I hope you enjoy using it. +thank you for acquiring Furnace! I hope you enjoy using it. + +# help -move Furnace to Applications (or some other place). if you are using a recent version of macOS, you may get an error saying that Furnace is damaged. in that case, open Terminal, and type this: @@ -13,3 +14,32 @@ xattr -d com.apple.quarantine /path/to/Furnace.app (replace `/path/to/Furnace.app` with the path where Furnace.app is located, e.g. `/Applications/Furnace.app`) you may need to reboot after doing this before launching Furnace. + + +some technical computing background is recommended for the best experience. +be sure to read the `manual.pdf` file for information on how to use this program. + +if you find issues (e.g. bugs or annoyances), report them. links below. + +# links + +- Furnace on GitHub (project page and issue tracker): https://github.com/tildearrow/furnace + - issues: https://github.com/tildearrow/furnace/issues + - discussion: https://github.com/tildearrow/furnace/discussions +- Furnace on Revolt: https://rvlt.gg/GRPS6tmc +- Furnace on Discord: https://discord.gg/EfrwT2wq7z +- online manual: https://tildearrow.org/furnace/doc/v0.6/ + +# notes + +copyright (C) 2021-2023 tildearrow and contributors. + +This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +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. + + +Furnace is NOT affiliated with Delek or DefleMask in any form, regardless of its ability to load and save the .dmf, .dmp and .dmw file formats. +additionally, Furnace does not intend to replace DefleMask, nor any other program. diff --git a/res/releaseReadme/stable-win.txt b/res/releaseReadme/stable-win.txt index 22eed14ca..562037c2c 100644 --- a/res/releaseReadme/stable-win.txt +++ b/res/releaseReadme/stable-win.txt @@ -1,5 +1,35 @@ # Furnace (chiptune tracker) -thank you for downloading Furnace! I hope you enjoy using it. +thank you for acquiring Furnace! I hope you enjoy using it. extract this archive, and run furnace.exe to get started. + +# help + +some technical computing background is recommended for the best experience. +be sure to read the `manual.pdf` file for information on how to use this program. + +if you find issues (e.g. bugs or annoyances), report them. links below. + +# links + +- Furnace on GitHub (project page and issue tracker): https://github.com/tildearrow/furnace + - issues: https://github.com/tildearrow/furnace/issues + - discussion: https://github.com/tildearrow/furnace/discussions +- Furnace on Revolt: https://rvlt.gg/GRPS6tmc +- Furnace on Discord: https://discord.gg/EfrwT2wq7z +- online manual: https://tildearrow.org/furnace/doc/v0.6/ + +# notes + +copyright (C) 2021-2023 tildearrow and contributors. + +This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +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. + + +Furnace is NOT affiliated with Delek or DefleMask in any form, regardless of its ability to load and save the .dmf, .dmp and .dmw file formats. +additionally, Furnace does not intend to replace DefleMask, nor any other program. diff --git a/scripts/release-linux.sh b/scripts/release-linux.sh index 563e08127..f712d11db 100755 --- a/scripts/release-linux.sh +++ b/scripts/release-linux.sh @@ -50,7 +50,7 @@ rmdir share || exit 1 cd .. cp ../../../LICENSE . || exit 1 -cp ../../../README.md . || exit 1 +cp ../../res/releaseReadme/stable-linux.txt README.md || exit 1 cp -r ../../../papers papers || exit 1 cp -r ../../../doc doc || exit 1 rmdir usr || exit 1 diff --git a/scripts/release-win32.sh b/scripts/release-win32.sh index d189ca6de..b1a1fbf67 100755 --- a/scripts/release-win32.sh +++ b/scripts/release-win32.sh @@ -25,7 +25,7 @@ cd release/win32 cp ../../LICENSE LICENSE.txt || exit 1 cp ../../win32build/furnace.exe . || exit 1 -cp ../../README.md README.txt || exit 1 +cp ../../res/releaseReadme/stable-win.txt README.txt || exit 1 cp -r ../../papers papers || exit 1 cp -r ../../doc doc || exit 1 cp -r ../../demos demos || exit 1 diff --git a/scripts/release-win64.sh b/scripts/release-win64.sh index 9183007b5..b04a16c82 100755 --- a/scripts/release-win64.sh +++ b/scripts/release-win64.sh @@ -25,7 +25,7 @@ cd release/windows cp ../../LICENSE LICENSE.txt || exit 1 cp ../../winbuild/furnace.exe . || exit 1 -cp ../../README.md README.txt || exit 1 +cp ../../res/releaseReadme/stable-win.txt README.txt || exit 1 cp -r ../../papers papers || exit 1 cp -r ../../doc doc || exit 1 cp -r ../../demos demos || exit 1 diff --git a/scripts/release-winxp.sh b/scripts/release-winxp.sh index 9242bfc6c..4d51e6be8 100755 --- a/scripts/release-winxp.sh +++ b/scripts/release-winxp.sh @@ -25,7 +25,7 @@ cd release/winxp cp ../../LICENSE LICENSE.txt || exit 1 cp ../../xpbuild/furnace.exe . || exit 1 -cp ../../README.md README.txt || exit 1 +cp ../../res/releaseReadme/stable-win.txt README.txt || exit 1 cp -r ../../papers papers || exit 1 cp -r ../../doc doc || exit 1 cp -r ../../demos demos || exit 1