diff --git a/INSTALL.md b/INSTALL.md index dd0fed1..b3ab668 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -7,7 +7,7 @@ By Perry R. Cook and Gary P. Scavone, 1995--2012. The Synthesis ToolKit in C++ can be used in a variety of ways, depending on your particular needs. Some people simmply choose the classes they need for a particular project and copy those to their project directory. Others like to compile and link to a library of object files. STK was not designed with one particular style of use in mind. -To configure and compile (on Unix systems and MinGW): +## Unix systems and MinGW 1. If you downloaded the software from the git repository, first run autoconf, @@ -47,6 +47,10 @@ If you wish to use a different compiler than that selected by configure, specify ./configure CXX=CC -## For Windows Users +## Windows MinGW support is provided in the configure script. In addition, Visual C++ 6.0 project files are included for each of the example STK projects, though these may not work with more recent versions of Visual Studio. + +##iOS + +You can integrate the STK in iOS projects either by using its iOS static library or Cocoapods. See the [iOS README file](iOS/README-iOS.md) for instructions. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ad975d1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,27 @@ +The Synthesis ToolKit in C++ (STK) + +Copyright (c) 1995-2012 Perry R. Cook and Gary P. Scavone + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +Any person wishing to distribute modifications to the Software is +asked to send the modifications to the original developer so that they +can be incorporated into the canonical version. This is, however, not +a binding provision of this license. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +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. diff --git a/README.md b/README.md index 175db31..0c9f3fe 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,27 @@ -% The Synthesis ToolKit in C++ (STK) -% Perry R. Cook and Gary P. Scavone -% 1995--2012 - # The Synthesis ToolKit in C++ (STK) By Perry R. Cook and Gary P. Scavone, 1995--2012. This distribution of the Synthesis ToolKit in C++ (STK) contains the following: -* `include`: STK class header files -* `src`: STK class source files -* `rawwaves`: STK audio files (1-channel, 16-bit, big-endian) -* `doc`: STK documentation -* `projects`: example STK projects and programs +* [`include`](include/): STK class header files +* [`src`](src/): STK class source files +* [`rawwaves`](rawwaves): STK audio files (1-channel, 16-bit, big-endian) +* [`doc`](doc): STK documentation +* [`projects`](projects): example STK projects and programs -Please read the Legal and Ethical notes near the bottom of this document. +Please read the [Legal and Ethical notes](#legal-and-ethical) near the bottom of this document and the [License](LICENSE). -For compiling and installing STK, see the INSTALL.md file in this directory. +For compiling and installing STK, see the [INSTALL.md](INSTALL.md) file in this directory. +##Contents + +* [Overview](#overview) +* [System Requirements](#system-requirements) +* [What's New (and not so new)](#whats-new-and-not-so-new) +* [Disclaimer](#disclaimer) +* [Legal and Ethical](#legal-and-ethical) +* [Further Reading](#further-reading) +* [Perry's Notes From the Original Distribution](#perrys-notes-from-the-original-distribution) # OVERVIEW @@ -143,38 +148,6 @@ public domain. To avoid subtle legal issues, we'll not state what's freely useable here, but we'll try to note within the various classes where certain things are likely to be protected by patents. -# LICENSE - -STK WWW site: - -The Synthesis ToolKit in C++ (STK) - -Copyright (c) 1995-2012 Perry R. Cook and Gary P. Scavone - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -Any person wishing to distribute modifications to the Software is -asked to send the modifications to the original developer so that they -can be incorporated into the canonical version. This is, however, not -a binding provision of this license. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -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. - # FURTHER READING diff --git a/iOS/README.md b/iOS/README-iOS.md similarity index 100% rename from iOS/README.md rename to iOS/README-iOS.md