Compile readme, licenses, and changelog as Markdown to HTML for distribution.

CHANGELOG.md

@@ -1,4 +1,4 @@
-#### Preface
+# VCV Rack changelog
 
 In this document, Mod is Ctrl on Windows/Linux and Cmd on Mac.
 

LICENSE-dist.txt → LICENSE-dist.md

@@ -1,5 +1,8 @@
-# GLEW
+# Licenses of libraries used in VCV Rack
 
+## GLEW
+
+```
 The OpenGL Extension Wrangler Library
 Copyright (C) 2002-2007, Milan Ikits <milan ikits[]ieee org>
 Copyright (C) 2002-2007, Marcelo E. Magallon <mmagallo[]debian org>
@@ -73,9 +76,9 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
+```
 
-
-# GLFW
+## GLFW
 
 Copyright © 2002-2006 Marcus Geelnard
 
@@ -85,15 +88,15 @@ This software is provided ‘as-is’, without any express or implied warranty.
 
 Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
 
-    The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
-
-    Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
+* The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
 
-    This notice may not be removed or altered from any source distribution.
+* Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
 
+* This notice may not be removed or altered from any source distribution.
 
-# jansson
+## jansson
 
+```
 Copyright (c) 2009-2016 Petri Lehtinen <petri@digip.org>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -113,10 +116,11 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+```
 
+## OpenSSL
 
-# OpenSSL
-
+```
   OpenSSL License
   ---------------
 
@@ -233,9 +237,9 @@ THE SOFTWARE.
  * copied and put under another distribution licence
  * [including the GNU Public Licence.]
  */
+```
 
-
-# curl
+## curl
 
 Copyright (c) 1996 - 2017, Daniel Stenberg, daniel@haxx.se, and many contributors, see the THANKS file.
 
@@ -247,9 +251,9 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 Except as contained in this notice, the name of a copyright holder shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization of the copyright holder.
 
+## Zstandard
 
-# Zstandard
-
+```
 Copyright (c) 2016-present, Facebook, Inc. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -276,10 +280,11 @@ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
 
+## libarchive
 
-# libarchive
-
+```
 The libarchive distribution as a whole is Copyright by Tim Kientzle
 and is subject to the copyright notice reproduced at the bottom of
 this file.
@@ -346,10 +351,11 @@ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
 
+## libspeexdsp
 
-# libspeexdsp
-
+```
 Copyright 2002-2008   Xiph.org Foundation
 Copyright 2002-2008   Jean-Marc Valin
 Copyright 2005-2007 Analog Devices Inc.
@@ -385,10 +391,11 @@ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
 
+## libsamplerate
 
-# libsamplerate
-
+```
 Copyright (c) 2012-2016, Erik de Castro Lopo <erikd@mega-nerd.com>
 All rights reserved.
 
@@ -414,9 +421,9 @@ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
 
-
-# RtMidi
+## RtMidi
 
 RtMidi: realtime MIDI i/o C++ classes
 Copyright (c) 2003-2017 Gary P. Scavone
@@ -443,9 +450,9 @@ ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+## RtAudio
 
-# RtAudio
-
+```
 RtAudio: a set of realtime audio i/o C++ classes
 Copyright (c) 2001-2017 Gary P. Scavone
 
@@ -472,10 +479,11 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
 
+## nanovg
 
-# nanovg
-
+```
 Copyright (c) 2013 Mikko Mononen memon@inside.org
 
 This software is provided 'as-is', without any express or implied
@@ -493,10 +501,11 @@ appreciated but is not required.
 2. Altered source versions must be plainly marked as such, and must not be
 misrepresented as being the original software.
 3. This notice may not be removed or altered from any source distribution.
+```
 
+## nanosvg
 
-# nanosvg
-
+```
 Copyright (c) 2013-14 Mikko Mononen memon@inside.org
 
 This software is provided 'as-is', without any express or implied
@@ -514,10 +523,11 @@ appreciated but is not required.
 2. Altered source versions must be plainly marked as such, and must not be
 misrepresented as being the original software.
 3. This notice may not be removed or altered from any source distribution.
+```
 
+## Blendish
 
-# Blendish
-
+```
 Copyright (c) 2014 Leonard Ritter <leonard.ritter@duangle.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -537,15 +547,137 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
-
-
-# osdialog
-
-(CC0 1.0 Universal, no attribution needed)
-
-
-# pffft
-
+```
+
+## osdialog
+
+```
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.
+```
+
+## pffft
+
+```
 Copyright (c) 2013  Julien Pommier ( pommier@modartt.com )
 
 Based on original fortran 77 code from FFTPACKv4 from NETLIB,
@@ -591,9 +723,9 @@ EXEMPLARY, OR CONSEQUENTIAL DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
 SOFTWARE.
+```
 
-
-# fuzzysearchdatabase
+## fuzzysearchdatabase
 
 Copyright 2020 Nils Jonas Norberg <jnorberg@gmail.com>
 
@@ -609,9 +741,9 @@ Redistribution and use in source and binary forms, with or without modification,
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+## ghc/filesystem
 
-# ghc/filesystem
-
+```
 Copyright (c) 2018, Steffen Schümann <s.schuemann@pobox.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -631,3 +763,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+```

LICENSE.md

@@ -1,4 +1,4 @@
-# VCV Rack Licenses
+# VCV Rack licenses
 
 VCV Rack **source code** is copyright © 2016-2021 VCV.
 

Makefile

@@ -138,7 +138,7 @@ ifdef ARCH_WIN
 endif
 
 
-DIST_RES := LICENSE* CHANGELOG.md res cacert.pem Core.json template.vcv
+DIST_RES := res cacert.pem Core.json template.vcv
 DIST_NAME := Rack-"$(VERSION)"-$(ARCH)
 DIST_SDK_DIR := Rack-SDK
 DIST_SDK := Rack-SDK-$(VERSION).zip
@@ -147,9 +147,12 @@ ifdef ARCH_MAC
 else
 	DIST_DIR := Rack
 endif
+DIST_MD := $(wildcard *.md)
+DIST_HTML := $(patsubst %.md, build/%.html, $(DIST_MD))
+
 
 # This target is not supported for public use
-dist: $(TARGET) $(STANDALONE_TARGET)
+dist: $(TARGET) $(STANDALONE_TARGET) $(DIST_HTML)
 	rm -rf dist
 	mkdir -p dist
 
@@ -165,7 +168,8 @@ ifdef ARCH_LIN
 	ldd dist/"$(DIST_DIR)"/$(STANDALONE_TARGET)
 	# Copy resources
 	cp -R $(DIST_RES) dist/"$(DIST_DIR)"/
-	cp Fundamental.vcvplugin dist/"$(DIST_DIR)"/
+	cp $(DIST_HTML) dist/"$(DIST_DIR)"/
+	cp plugins/Fundamental/dist/Fundamental-*.vcvplugin dist/"$(DIST_DIR)"/Fundamental.vcvplugin
 	# Make ZIP
 	cd dist && zip -q -9 -r $(DIST_NAME).zip Rack
 endif
@@ -186,8 +190,9 @@ ifdef ARCH_MAC
 	cp Info.plist dist/"$(DIST_DIR)"/Contents/
 	$(SED) 's/{VERSION}/$(VERSION)/g' dist/"$(DIST_DIR)"/Contents/Info.plist
 	cp -R $(DIST_RES) dist/"$(DIST_DIR)"/Contents/Resources/
+	cp $(DIST_HTML) dist/"$(DIST_DIR)"/Contents/Resources/
 	cp -R icon.icns dist/"$(DIST_DIR)"/Contents/Resources/
-	cp Fundamental.vcvplugin dist/"$(DIST_DIR)"/Contents/Resources/
+	cp plugins/Fundamental/dist/Fundamental-*.vcvplugin dist/"$(DIST_DIR)"/Fundamental.vcvplugin
 	# Clean up and sign bundle
 	xattr -cr dist/"$(DIST_DIR)"
 	# This will only work if you have the private key to my certificate
@@ -204,10 +209,11 @@ ifdef ARCH_WIN
 	$(STRIP) -s dist/"$(DIST_DIR)"/$(STANDALONE_TARGET)
 	# Copy resources
 	cp -R $(DIST_RES) dist/"$(DIST_DIR)"/
+	cp $(DIST_HTML) dist/"$(DIST_DIR)"/
 	cp /mingw64/bin/libwinpthread-1.dll dist/"$(DIST_DIR)"/
 	cp /mingw64/bin/libstdc++-6.dll dist/"$(DIST_DIR)"/
 	cp /mingw64/bin/libgcc_s_seh-1.dll dist/"$(DIST_DIR)"/
-	cp Fundamental.vcvplugin dist/"$(DIST_DIR)"/
+	cp plugins/Fundamental/dist/Fundamental-*.vcvplugin dist/"$(DIST_DIR)"/Fundamental.vcvplugin
 	# Make ZIP
 	cd dist && zip -q -9 -r $(DIST_NAME).zip "$(DIST_DIR)"
 	# Make NSIS installer

README.md

@@ -28,7 +28,7 @@
 - [NanoVG](https://github.com/memononen/nanovg)
 - [NanoSVG](https://github.com/memononen/nanosvg)
 - [oui-blendish](https://github.com/geetrepo/oui-blendish)
-- [osdialog](https://github.com/AndrewBelt/osdialog) (written by Andrew Belt)
+- [osdialog](https://github.com/AndrewBelt/osdialog) (written by Andrew Belt for VCV Rack)
 - [ghc::filesystem](https://github.com/gulrak/filesystem)
 - [Jansson](https://digip.org/jansson/)
 - [libcurl](https://curl.se/libcurl/)

compile.mk

@@ -87,3 +87,6 @@ ifdef ARCH_MAC
 	@# Apple makes this needlessly complicated, so just generate a C file with an array.
 	xxd -i $< | $(CC) $(MAC_SDK_FLAGS) -c -o $@ -xc -
 endif
+
+build/%.html: %.md
+	markdown -f fencedcode -o $@ $<