1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-04-29 15:19:44 +02:00

Improve documentation

- Get rid of INSTALL and README.txt
- Change references of Mac OS X to macOS
This commit is contained in:
James Pearson 2021-07-07 01:16:29 -04:00 committed by GitHub
parent d28166652c
commit 762175fb61
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 5 additions and 149 deletions

View File

@ -1,142 +1,3 @@
Audacity(R): free, open source, cross-platform audio software for
multi-track recording and editing: https://www.audacityteam.org/ .
User support is provided on Audacity Forum:
https://forum.audacityteam.org/ .
We welcome feedback on Audacity, suggestions for new or improved features,
and bug reports. Please visit
https://forum.audacityteam.org/viewforum.php?f=25 .
Audacity is copyright (c) 1999-2021 by Audacity Team. This copyright
notice applies to all documents in the Audacity source code archive,
except as otherwise noted (mostly in the lib-src subdirectories).
"Audacity" is a registered trademark of Dominic Mazzoni.
The Audacity documentation is licensed under the Creative Commons
Attribution 3.0 license: https://creativecommons.org/licenses/by/3.0/legalcode .
Compilation instructions for Audacity are provided in the source code:
* Windows: win\build.txt
* macOS: mac/build.txt
* GNU/Linux: linux/build.txt
You can ask for help with compilation problems at:
https://forum.audacityteam.org/viewforum.php?f=19 .
If you want to suggest some simple text change in our code, please submit a
pull request on https://github.com/audacity/audacity/pulls . It's usually
best to discuss functional code changes with us first on audacity-devel:
https://lists.sourceforge.net/lists/listinfo/audacity-devel .
Version 3.0.3
Contents of this README:
1. Licensing
2. Changes since version 3.0.2
3. Known Issues at Release
4. Source Code, Libraries and Additional Copyright Information
--------------------------------------------------------------------------------
1. Licensing
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version. The program source code is also freely
available as per Section 4 of this README.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details.
You should have received a copy of the GNU General Public License
along with this program (in a file called LICENSE.txt); if not, go
to https://www.gnu.org/licenses/old-licenses/gpl-2.0.html or write to
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307 USA
--------------------------------------------------------------------------------
2. Changes since version 3.0.0:
Improvements
* More information to help Audacity developers is now provided
with most error reports.
* Manage Macros dialog is now clearer about how to save and
close the dialog, thanks to changes in buttons.
* In MP3 export we removed a legacy option for a slower encoding
that is no better than the faster one.
See also: https://wiki.audacityteam.org/wiki/New_features_in_Audacity_3.0.2
Bug Fixes
Over 30 bugs in 3.0.0 fixed, including:
* 2676 - Export: Incorrect handling over 0 dB
* 2692 - Mac: VI users get trapped in radio buttons of Keyboard Preferences
* 2694 - Coloring of tracks in Mixer Board are awry
* 2696 - Metadata Editor: changed size is not remembered/restored on next use
* 2697 - Linux: AUP3 projects use incorrect char size on "differently"
configured wxWidgets
* 2698 - Noise Gate fails silently if "hold" is non-zero
* 2699 - Windows: Cannot edit labels with emoji in them correctly
* 2701 - Progress dialog interferes with scripting
* 2703 - Mac: EGAT preview dialog is hidden behind the EGAT dialog
* 2704 - Mac: Stop button in EGATs with Preview does nor stop the preview
* 2706 - Win: Vocal Reduction and Isolation most options fail
* 2707 - Opened projects not being removed from "audacity.cfg"
* 2708 - Nyquist effects fail silently with One hour plus stereo
* 2709 - Mac: Missing sub-menu check marks in French
* 2710 - Compressor with audio before T=0 crashes Audacity
* 2714 - (Japanese & Korean) "Unable to parse project information"
* 2716 - Cleared "Recent Files" are restored on next launch
* 2718 - Failed to execute a project file command (on server)
* 2720 - Cannot open project that's in a read only folder - error message vague
* 2722 - Noise Gate fails on a one hour stereo selection
See also: https://wiki.audacityteam.org/wiki/Release_Notes_3.0.2
-------------------------------------------------------------------------------
3. Some Known Issues in 3.0.2:
We have two significant bugs we would like help in tracking down:
1) Audacity may occasionally report "Failed to open the project
database". We don't think this is causing people to lose data.
2) Audacity may offer to 'recover' a project at start up, when
there is nothing to recover.
If there are repeatable steps to make these bugs happen, this
could help us track down what is causing them.
For best workarounds and other known issues in 3.0.2, please see:
https://wiki.audacityteam.org/wiki/Release_Notes_3.0.2/Issues
-------------------------------------------------------------------------------
4. Source Code, Libraries and Additional Copyright Information
Source code to this program is always available; for more information visit
our web site at:
https://www.audacityteam.org/download/source
Audacity is built upon other free libraries; some of these libraries may have
come with Audacity in the lib-src directory. Others you are expected to install
first if you want Audacity to have certain capabilities. Most of these libraries

View File

@ -1,7 +0,0 @@
Compilation and install instructions
Compilation instruction for Audacity is available at https://github.com/audacity/audacity/blob/master/BUILDING.md
You can ask for help with compilation problems at:
http://forum.audacityteam.org/viewforum.php?f=19 .

View File

@ -1,11 +1,13 @@
Note: Audacity is distributed under the terms of the GNU GPL Version 2.
Note: Tenacity is distributed under the terms of the GNU GPL Version 2.
This includes everything in the source code distribution
except code in the lib-src directory. Code in the lib-src
directory may be released under a different license
(which is GPL-compatible). For a summary, see the
README.txt file, and for specific details, see the license
3RDPARTY.txt file, and for specific details, see the license
information inside each subdirectory of lib-src.
Tenacity is based upon Audacity, Copyright (c) 1999-2021 The Audacity Team
Documentation is distributed under the Creative Commons license (CC BY 3.0)
Please see here for that:
http://creativecommons.org/licenses/by/3.0/legalcode

View File

@ -4,7 +4,7 @@ Fork of audacity/audacity
### This repository is a fork of the audacity repository that tries to revert all the changes that some members of the community felt didn't take the Audacity software project in a direction they desire.
This fork of **audacity** is an easy-to-use, cross-platform multi-track audio editor/recorder for Windows, Mac OS X, GNU/Linux and other operating systems and is developed by a group of volunteers as open source software.
This fork of **audacity** is an easy-to-use, cross-platform multi-track audio editor/recorder for Windows, macOS, GNU/Linux and other operating systems and is developed by a group of volunteers as open source software.
- **Recording** from audio devices (real or virtual)
- **Export / Import** a wide range of audio formats (extendible with FFmpeg)