rtaudio
A set of C++ classes that provide a common API for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound, ASIO, and WASAPI) operating systems.

Getting Started

Hello and welcome to DocsForge. We thank you for uploading your project.

To help you get started, we auto-documented your code (in the public API section), added a few basic tutorial pages, and a few advanced tutorial pages. We've also randomly marked some API pages as part of the basic and advanced tutorial.

Tutorial levels:

  • The Basic Tutorial should get new users starting with the basic features.

  • The Advanced Tutorial should be for users that need more customization.

  • The Public API should be for users that need even more customization.

Buttons:

: Add a documentation page.

: Delete documentation page. API pages can be deleted as well.

: Mark page (including API pages) as part of the Basic or Advanced tutorial.

: Edit page (including API pages) using Markdown. API pages can diverge from the documentation inside your code.

: More options in project settings.

Tip

The auto created API might be bigger than you wish to display to the end user. Read the help section on how to customize which parts you want to display, and which you want to hide.

Documentation pages can be linked to markdown files in your repository. For example, this page is linked to the README markdown file (extension .md) of your repository, and stores a copy of its content.

If you do have a README file, you will probably notice the [≠] icon representing changes relative to the autodoc version. You can review all changed pages through the project's settings.

Notice that you have dedicated release notes page on the sidebar that you can edit.

An example to get you started on how Getting Started page should look like:


Example Getting Started

Describe in a few sentences what your project does...

Basic Example

A few words and a basic code example. A good project works "out of the box" with default configuration that fits most users.

//
//

How To

More advanced usage of your project, linking to the individual function pages in your API. In each of these pages, give code examples. For example:

License

The RtAudio license is similar to the MIT License.

RtAudio: a set of realtime audio i/o C++ classes
Copyright (c) 2001-2016 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.

Final Notes

  • You don't have to have a page called Getting Started. Your project page - http://docsforge.com/5/rtaudio/docs/ will always find the 1st page amongst the Basic Tutorial pages. There must always be at least one Basic Tutorial page.

  • In the 1st Basic Tutorial page, there must always be a License section, as there are links pointing to it.

  • Programmers learn through examples. Having a good and small public API, each having a manual page with code examples, can be a lot easier than reading a long tutorial.



Discussions

There are 0 discussions relevant for this page, and 0 discussions in the whole project.




Add Discussion

Log in to comment