e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-05-03 12:28:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Convert README and INSTALL instructions to markdown.

Browse Source
This commit is contained in:
Stephen Sinclair
2013-09-25 15:17:08 +02:00
committed by Stephen Sinclair
parent c8b7b67680
commit 3d0db65b1c
2 changed files with 47 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
INSTALL
View File

@@ -1,18 +1,24 @@
The Synthesis ToolKit in C++ (STK) % The Synthesis ToolKit in C++ (STK)
% By Perry R. Cook and Gary P. Scavone, 1995-2012.
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. 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): To configure and compile (on Unix systems and MinGW):
1. Unpack the STK distribution (tar -xzf stk-4.x.x.tar.gz). 1. If you downloaded the software from the git repository, first run autoconf,
autoconf
otherwise, if you downloaded the software from the STK source distribution, unpack the tar file,
tar -xzf stk-4.x.x.tar.gz
2. From within the directory containing this file, run configure: 2. From within the directory containing this file, run configure:
./configure ./configure
3. From within each project directory, type "make". 3. From within each project directory, type `make`.
4. To compile a library of objects, type "make" from within the src directory. 4. To compile a library of objects, type `make` from within the `src` directory.
Several options can be passed to configure, including: Several options can be passed to configure, including:
@@ -25,7 +31,7 @@ Several options can be passed to configure, including:
--with-asio = choose ASIO API support (windows only) --with-asio = choose ASIO API support (windows only)
--with-ds = choose DirectSound API support (windows only) --with-ds = choose DirectSound API support (windows only)
It is now possible to specify more than one audio and MIDI API where supported. Note, however, that the ALSA library is required in order to compile the RtMidi class in Linux if the "--with-oss" option is provided (only the OSS audio API will be used, not the OSS MIDI API). Typing "./configure --help" will display all the available options. In addition, it is possible to specify the RAWWAVES and INCLUDE paths to configure as (ex. to set to /home/me/rawwaves and /home/me/include): It is now possible to specify more than one audio and MIDI API where supported. Note, however, that the ALSA library is required in order to compile the RtMidi class in Linux if the `--with-oss` option is provided (only the OSS audio API will be used, not the OSS MIDI API). Typing `./configure --help` will display all the available options. In addition, it is possible to specify the RAWWAVES and INCLUDE paths to configure as (ex. to set to /home/me/rawwaves and /home/me/include):
./configure RAWWAVE_PATH='$(HOME)/rawwaves/' ./configure RAWWAVE_PATH='$(HOME)/rawwaves/'
./configure INCLUDE_PATH='$(HOME)/include/' ./configure INCLUDE_PATH='$(HOME)/include/'
@@ -37,6 +43,6 @@ If you wish to use a different compiler than that selected by configure, specify
./configure CXX=CC ./configure CXX=CC
For Windows Users: ## For Windows Users
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. 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.

36
README
View File

@@ -1,21 +1,20 @@
The Synthesis ToolKit in C++ (STK) % The Synthesis ToolKit in C++ (STK)
% By Perry R. Cook and Gary P. Scavone, 1995-2012.
By Perry R. Cook and Gary P. Scavone, 1995-2012.
This distribution of the Synthesis ToolKit in C++ (STK) contains the following: This distribution of the Synthesis ToolKit in C++ (STK) contains the following:
include: STK class header files * `include`: STK class header files
src: STK class source files * `src`: STK class source files
rawwaves: STK audio files (1-channel, 16-bit, big-endian) * `rawwaves`: STK audio files (1-channel, 16-bit, big-endian)
doc: STK documentation * `doc`: STK documentation
projects: example STK projects and programs * `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 near the bottom of this document.
For compiling and installing STK, see the INSTALL file in this directory. For compiling and installing STK, see the INSTALL.md file in this directory.
OVERVIEW: # OVERVIEW
The Synthesis ToolKit in C++ (STK) is a set of open source audio The Synthesis ToolKit in C++ (STK) is a set of open source audio
signal processing and algorithmic synthesis classes written in the C++ signal processing and algorithmic synthesis classes written in the C++
@@ -63,7 +62,7 @@ and SKINI (Synthesis ToolKit Instrument Network Interface, a MIDI-like
text message synthesis control format). text message synthesis control format).
SYSTEM REQUIREMENTS: # SYSTEM REQUIREMENTS
See the individual README's (eg. README-linux) in the /doc directory See the individual README's (eg. README-linux) in the /doc directory
for platform specific information and system requirements. In for platform specific information and system requirements. In
@@ -73,7 +72,7 @@ example programs. To use the Tcl/Tk GUIs, you will need Tcl/Tk
version 8.0 or higher. version 8.0 or higher.
WHAT'S NEW (AND NOT SO NEW): # WHAT'S NEW (AND NOT SO NEW)
Despite being available in one form or another since 1996, we still Despite being available in one form or another since 1996, we still
consider STK to be alpha software. We attempt to maintain backward consider STK to be alpha software. We attempt to maintain backward
@@ -113,7 +112,7 @@ configure script generates a Makefile in the src directory that will
accomplish that. accomplish that.
DISCLAIMER: # DISCLAIMER
You probably already guessed this, but just to be sure, we don't You probably already guessed this, but just to be sure, we don't
guarantee anything works. :-) It's free ... what do you expect? If guarantee anything works. :-) It's free ... what do you expect? If
@@ -122,7 +121,7 @@ can also make suggestions, but again, no guarantees. Send email to
the mail list. the mail list.
LEGAL AND ETHICAL: # LEGAL AND ETHICAL
This software was designed and created to be made publicly available This software was designed and created to be made publicly available
for free, primarily for academic purposes, so if you use it, pass it for free, primarily for academic purposes, so if you use it, pass it
@@ -140,11 +139,12 @@ 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 freely useable here, but we'll try to note within the various classes
where certain things are likely to be protected by patents. where certain things are likely to be protected by patents.
LICENSE: # LICENSE
STK WWW site: http://ccrma.stanford.edu/software/stk/ STK WWW site: <http://ccrma.stanford.edu/software/stk/>
The Synthesis ToolKit in C++ (STK) The Synthesis ToolKit in C++ (STK)
Copyright (c) 1995-2012 Perry R. Cook and Gary P. Scavone Copyright (c) 1995-2012 Perry R. Cook and Gary P. Scavone
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
@@ -172,7 +172,7 @@ CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FURTHER READING: # FURTHER READING
For complete documentation on this ToolKit, the classes, etc., see the For complete documentation on this ToolKit, the classes, etc., see the
doc directory of the distribution or surf to doc directory of the distribution or surf to
@@ -180,7 +180,7 @@ http://ccrma.stanford.edu/software/stk/. Also check the platform
specific README's for specific system requirements. specific README's for specific system requirements.
PERRY'S NOTES FROM THE ORIGINAL DISTRIBUTION: # PERRY'S NOTES FROM THE ORIGINAL DISTRIBUTION
This whole world was created with no particular hardware in mind. This whole world was created with no particular hardware in mind.
These examples are intended to be tutorial in nature, as a platform These examples are intended to be tutorial in nature, as a platform