You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

56 lines
2.0 KiB

  1. /**********************************************************************
  2. Audacity: A Digital Audio Editor
  3. MainPage.dox2
  4. James Crook
  5. ********************************************************************//**
  6. \mainpage Audacity Index Page
  7. \section intro_sec Introduction
  8. Audacity is a free, easy-to-use audio editor and recorder for Windows,
  9. Mac OS X, GNU/Linux, and other operating systems.
  10. \section license License
  11. Audacity is free software, developed by a group of volunteers and
  12. distributed under the GNU General Public License (GPL). See
  13. License.txt for details.
  14. Free software is not just free of cost (like "free beer").
  15. It is free as in freedom (like "free speech"). Free software gives you
  16. the freedom to use a program, study how it works, improve it, and share
  17. it with others. For more information, visit the Free Software Foundation.
  18. Programs like Audacity are also called open source software, because their
  19. source code is available for anyone to study or use. There are thousands of
  20. other free and open source programs, including the Mozilla web browser, the
  21. office suite, and entire Linux-based operating systems.
  22. \section src_code Understanding The Source Code
  23. To understand the GUI parts of Audacity, you will first need to familiarise
  24. yourself with the wxWidgets toolkit. You will find \ref ShuttleSystem used very
  25. widely for user interface construction. See the classes in src/widgets
  26. for how we create new widgets of our own.
  27. - A great deal of the Audio processing in Audacity is done using libraries of
  28. code such as libsndfile and allegro. Some self contained audio functions
  29. can be found in src/effects, for example EffectEcho and its accompanying
  30. dialog EchoDialog.
  31. - The BlockFile system is central to how Audacity allows cut and paste
  32. of audio to be performed efficiently. It works closely with the DirManager
  33. class.
  34. Also look at the overview pages in the Doxygen documentation, which cover
  35. special topics.
  36. *//**************************************************************************/