e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-23 23:58:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs for windows. Still could use some re-org but would need to consider all platforms.

Browse Source 
Fixed a few links. Still lots more broken.
This commit is contained in:
cepthomas
2018-11-13 12:28:23 -06:00
parent 2fffa79174
commit e4d373b658
4 changed files with 8 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/doxygen/compile.txt
View File

@@ -2,6 +2,7 @@
The Synthesis ToolKit can be used in a variety of ways, depending on your particular needs. Some people choose the classes they need for a particular project and copy those to their working directory. Others create <TT>Makefiles</TT> that compile project-specific class objects from common <TT>src</TT> and <TT>include</TT> directories. And still others like to compile and link to a common library of object files. STK was not designed with one particular style of use in mind.
For specifics on creating Windows applications, see README-Win.txt.
\section rtvsnonrt "Realtime" vs. "Non-Realtime"
@@ -104,24 +105,5 @@ g++ -Wall -D__LITTLE_ENDIAN__ -o sineosc sineosc.cpp -lstk
\endcode
\section compileWin Windows:
STK has been tested on Windows platforms using the Visual .NET compiler
only. It is assumed here that you're familiar with Visual C++ and its
particular idiosyncrasies. STK won't compile in Visual C++ 6.0 any more.
The approach when using Visual C++ is to build a project that
includes the necessary ToolKit files from the distribution
<TT>src</TT> and <TT>include</TT> directories. For the example
program from the previous tutorial chapter, create a VC++ console
application project, add the Stk, FileRead, FileWrite, WvIn, FileWvIn,
FileLoop, WvOut, and FileWvOut class files, as well as
<TT>sineosc.cpp</TT>, and make sure the <TT>sinewave.raw</TT> file is
in the subdirectory <TT>rawwaves</TT>.
For programs using any of the STK realtime classes mentioned above, it is necessary to link with the DirectSound (<TT>dsound.lib</TT>), <TT>winmm.lib</TT>, and <TT>Wsock32.lib</TT> libraries, select the multithreaded library, and provide the <TT>__LITTLE_ENDIAN__</TT>, <TT>__WINDOWS_DS__</TT>, and <TT>__WINDOWS_MM__</TT> preprocessor definitions.
For Steinberg ASIO support, use the <TT>__WINDOWS_ASIO__</TT> preprocessor definition (and the <TT>__WINDOWS_MM__</TT> definition for RtMidi support), include all the files in the <TT>src/asio/</TT> directory (i.e., <TT>asio.h,cpp</TT>, <TT>asiodrivers.h,cpp</TT>, ...), and link with the <TT>winmm.lib</TT>, and <TT>Wsock32.lib</TT> libraries.
[<A HREF="tutorial.html">Main tutorial page</A>] &nbsp; [<A HREF="filtering.html">Next tutorial</A>]
*/