Mention contrib folder in readme, and explain in contrib readme what …

…the intended platforms are.
bbbradsmith · Feb 4, 2025 · 6af5406 · 6af5406
1 parent 22e0ebf
commit 6af5406
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/contrib/README.md b/contrib/README.md
@@ -1,6 +1,7 @@
 # NSFPlay Library
 
 This directory contains a `Makefile` for building an NSFPlay library.
+This is intended to be built on Windows with MSYS2, Linux, or MacOS.
 
 The library is just the core NSF/NSFe/M3U parser/emulator/renderer.
 It does not have routines/methods for creating a GUI, playing audio to

diff --git a/readme.txt b/readme.txt
@@ -6,6 +6,12 @@ This code is maintained by Brad Smith. It is a fork of NSFPlay/NSFPlug by Brezza
 Unstable preview builds will be automatically generated by Github Actions:
 - https://nightly.link/bbbradsmith/nsfplay/workflows/build/master
 
+The contrib folder contains source code for a few command line utilities,
+which can be used to render to WAV or work with NSF metadata.
+These can be built with make on Windows with MSYS2, or otherwise Linux or MacOS.
+
+.
+
 This code contains several modifications to original, see nsfplay.txt for a list of changes.
 
 I have presumed based on text comments and readme files in the original code that it is distributed freely, and modification and redistribution is permitted. The same permissive license applies to this version of the code I maintain. You may reuse this code without restriction, and no warranty or liability is implied on my part.