From ceb397b429b7ca3ff5c3537768166fc0e40d9d2c Mon Sep 17 00:00:00 2001 From: tildearrow Date: Wed, 21 May 2025 18:14:08 -0500 Subject: [PATCH] update readme - don't collapse chip list (will revert if it actually happens to intimidate people) - update installation instructions - change the doc section --- README.md | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index f337f4f6d..cfd4cffaa 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ the biggest multi-system chiptune tracker ever made! -[official site](https://tildearrow.org/furnace/) | [downloads](#downloads) | [installation](#installation) | [Unix/Linux packages](#packages) +[mini-site](https://tildearrow.org/furnace/) | [downloads](#downloads) | [installation](#installation) | [Unix/Linux packages](#packages) -[documentation/help](#quick-references) | [developer info](#developer-info) +[documentation/discussion//help](#quick-references) | [developer info](#developer-info) --- ## downloads @@ -17,10 +17,16 @@ for other operating systems, you may [build the source](#developer-info). [see here](https://nightly.link/tildearrow/furnace/workflows/build/master) for the latest unstable build. +## installation + +- **Windows:** extract the .zip into a new directory for Furnace (or one you've created before). make a shortcut for `furnace.exe` if you wish. +- **macOS:** drag `Furnace` into the Applications directory (or the folder of your choice). drag everything else into a separate directory. + - when opening Furnace for the first time, make sure to right-click the Furnace app icon and then select Open. +- **Linux/other:** instructions should be similar to Windows, unless you decide to install using your package manager (see [Unix/Linux packages](#packages)). + ## features --
a large selection of over 60 sound chips: - +- a large selection of sound chips: - Yamaha FM chips: - YM2151 (OPM) - YM2203 (OPN) @@ -102,8 +108,6 @@ for other operating systems, you may [build the source](#developer-info). - SID2 - SID3 - Generic PCM DAC -
- - mix and match sound chips! - over 200 ready to use presets from computers, game consoles and arcade boards... - ...or create your own presets - up to 32 chips or a total of 128 channels! @@ -119,7 +123,7 @@ for other operating systems, you may [build the source](#developer-info). - VGM export - ZSM export for Commander X16 - TIunA export for Atari 2600 - - SAP type R export for POKEY (playable by Altirra and [lzss-sap](https://github.com/dmsc/ lzss-sap)) + - SAP type R export for POKEY (playable by Altirra and [lzss-sap](https://github.com/dmsc/lzss-sap)) - audio file export - entire song, per chip or per channel - quality emulation cores (Nuked, MAME, SameBoy, Mednafen PCE, NSFplay, puNES, reSID, Stella, SAASound, vgsound_emu and ymfm) - wavetable synthesizer @@ -151,18 +155,11 @@ for other operating systems, you may [build the source](#developer-info). # quick references - **help**: - - new to Furnace? check out the [quick start guide](doc/1-intro/quickstart.md)! - - explore the thorough [documentation](doc/README.md). - - find answers to [frequently asked questions (FAQ)](doc/1-intro/faq.md). - - there's more at the Furnace [wiki](https://github.com/tildearrow/furnace/wiki). + - new to Furnace? check out the [quick start guide](doc/1-intro/quickstart.md). + - [documentation](doc/README.md). + - [frequently asked questions (FAQ)](doc/1-intro/faq.md). - **discussion**: see the [Discussions](https://github.com/tildearrow/furnace/discussions) section, or the [Discord](https://discord.gg/QhA26dXD23). -## installation - -- **Windows:** make a new folder for Furnace, unpack the .zip into it, and make a shortcut for `furnace.exe` to place wherever you like. -- **MacOS:** drag `furnace.app` into the Applications folder (or the folder of your choice). drag everything else into a separate folder or the folder of the .app depending on previous step. -- **Linux:** either install via package manager or get from releases page. instructions should be similar to Windows, except for shortcuts, which may be either .desktop files or links. - ## packages [![Packaging status](https://repology.org/badge/vertical-allrepos/furnace.svg)](https://repology.org/project/furnace/versions)