ReadySetGit/Release-Notes.md

177 lines
5.6 KiB
Markdown
Raw Normal View History

2023-03-24 16:29:16 +00:00
<!-- markdownlint-disable-next-line first-line-h1 -->
2018-08-14 12:48:17 +00:00
2023-03-24 16:29:16 +00:00
_TODO: For each release, copy this file and fill in the needed
information._
_TODO: Make sure to use the **product** name and **external** release
number, not internal information._
2018-08-14 12:48:17 +00:00
2018-08-24 10:30:24 +00:00
##### Product
2018-08-14 12:48:17 +00:00
2021-08-01 13:15:57 +00:00
::[PRODUCT-NAME](http://www.COMPANY.com/products/PRODUCT-NAME/)
2018-08-24 10:30:24 +00:00
##### Release Number
2021-08-01 13:15:57 +00:00
::X.Y.Z
2018-08-24 10:30:24 +00:00
##### Release Date
::YEAR/MONTH/DAY
##### Customer Support
2018-08-14 12:48:17 +00:00
2021-08-01 13:15:57 +00:00
::For more information or support, please visit our
[website](http://www.COMPANY.com/products/PRODUCT-NAME/) or email us
2018-08-14 12:48:17 +00:00
at <support@COMPANY.com>
2018-08-24 10:30:24 +00:00
---
2018-08-14 12:48:17 +00:00
### Introduction
2018-08-23 17:23:45 +00:00
::This document contains the release notes for PRODUCT-NAME version X.Y.Z.
2018-08-14 12:48:17 +00:00
The following sections describe the release in detail and provide
late-breaking or other information that supplements the main
documentation.
2023-03-24 16:29:16 +00:00
_TODO: Consider using one of the following example paragraphs._
2018-08-14 12:48:17 +00:00
::This is a developer release for internal evaluation only. Please report
any issues via the internal issue tracker.
::This is an early access release for evaluation and usage by select
partners. Your feedback is important to us, please help us make this the
best product possible.
::This is an early access release for wide evaluation and usage. Your
feedback is important to us, please help us make this the best product
2018-08-23 17:23:45 +00:00
possible. Keep in mind that we are continuing to work on PRODUCT-NAME and
2018-08-14 12:48:17 +00:00
things may change in the future.
::This is the first full release of this product. See the product website
for a complete description.
::(WHEN X IN VERSION NUMBER CHANGES) This is a major release with many new
features. Users of previous releases should check the "Version
Compatibility" section below for instructions on how to use existing
data with this new release.
::(WHEN Y IN VERSION NUMBER CHANGES) This is an upgrade release with some
significant enhancements. Users of previous releases are encouraged to
upgrade.
::(WHEN Z IN VERSION NUMBER CHANGES) This is a maintenance release that
improves quality, reliability, and performance without adding any new
functionality. All users of previous X.Y releases should upgrade to this
release.
::(WHEN DEFECT CORRECTION CLOSES SIGNIFICANT SECURITY HOLES) This is a
critical upgrade release that addresses recently discovered security
holes. All users of previous X.Y releases should upgrade immediately to
this release.
### What's New?
2023-03-24 16:29:16 +00:00
_TODO: Briefly list major user-visible enhancements. Or, note that
2018-08-14 12:48:17 +00:00
nothing major has been added. Technical issues should only be mentioned
if this is a reusable software component that will be used to build
larger products. Do not include issue numbers. Links to detailed
2023-03-24 16:29:16 +00:00
information can be helpful._
2018-08-14 12:48:17 +00:00
- ::Added 4 new play-back modes
- ::Increased play-back speed by as much as 30%
- ::(FOR REUSABLE COMPONENTS ONLY) Streamlined build process
- ::(FOR REUSABLE COMPONENTS ONLY) Roughly doubled unit test coverage
- ::Many improvements to the product's quality, reliability, ease of
use, and performance. See "Recent Changes" below for details.
### Installation and Upgrade Notes
2023-03-24 16:29:16 +00:00
_TODO: Fill in these sections. The text here is only an example._
2018-08-14 12:48:17 +00:00
#### ::Installation
2018-08-14 21:32:43 +00:00
::See the [installation instructions](Installation-Guide) for full details.
2023-03-24 16:29:16 +00:00
Please note that in this release, ...
2018-08-14 12:48:17 +00:00
::IMPORTANT: You must completely uninstall any previous "developer
2023-03-24 16:29:16 +00:00
release" or "early access" version of this product before installing
this release.
2018-08-14 12:48:17 +00:00
#### ::Manifest
::This release consists of the following items:
2018-08-24 10:30:24 +00:00
2018-08-14 12:48:17 +00:00
- ::Release notes (this file)
- ::Installation instructions / Quick start guide
- ::Product installer binary
- ::User guide
- ::Product source code and build instructions
### ::Minimum System Requirements
2018-08-24 10:30:24 +00:00
#### ::System Processor
2018-08-14 12:48:17 +00:00
::800MHz
2018-08-24 10:30:24 +00:00
#### ::System Memory
2018-08-14 12:48:17 +00:00
::256MB
2018-08-24 10:30:24 +00:00
#### ::Free Disk Space
2018-08-14 12:48:17 +00:00
::10MB
2018-08-24 10:30:24 +00:00
#### ::Operating System
2018-08-14 12:48:17 +00:00
::Windows 2000, Windows XP, Mac OS X, Linux (kernel 2.4)
2018-08-24 10:30:24 +00:00
#### ::Networking
2018-08-14 12:48:17 +00:00
::Internet access
2018-08-24 10:30:24 +00:00
#### ::Existing Software
2018-08-14 12:48:17 +00:00
- ::Standard e-mail client
- ::Popular web browser (IE6, NN7)
- ::SuperWaveEdit(TM) 2.0.2 (Needed for custom playback modes)
2018-08-24 10:30:24 +00:00
#### ::Version Compatibility
2018-08-14 12:48:17 +00:00
::Files saved by earlier versions of this product may be used with
this version. However, wave files saved in version W.Y.Z, must be
updated by using the WaveUpgrade utility.
### Recent Changes
2023-03-24 16:29:16 +00:00
_TODO: Query your public issue tracking system to produce a report of
2018-08-14 12:48:17 +00:00
changes in this release. Include the issue number, type, and one-line
summary. Include issues that were highlighted in the "What's New?"
section above. You may revise one-line summaries in the issue tracker,
prior to generating the report, if you notice that they are incorrect.
You may exclude or summarize changes that might give away valuable
2023-03-24 16:29:16 +00:00
proprietary information._
2018-08-14 12:48:17 +00:00
2021-08-01 13:15:57 +00:00
- ::FIX [09823](#tbd) Screen frozen when caps-lock is on
- ::FIX [09912](#tbd) Static heard while downloading
- ::FIX [10923](#tbd) Repeat-mode cannot play more than 99 times
- ::ENHANCEMENT [08237](#tbd) Scratch DJ-mode
- ::ENHANCEMENT [08238](#tbd) Chill DJ-mode
- ::ENHANCEMENT [08259](#tbd) Retro stereo-mode
- ::ENHANCEMENT [10202](#tbd) Techno-mode
2018-08-14 12:48:17 +00:00
### Known Problems and Workarounds
2023-03-24 16:29:16 +00:00
_TODO: Query your public issue tracking system to produce a report of
2018-08-14 12:48:17 +00:00
defects discovered in this release, or in previous releases that are
still not resolved. Include information on workarounds from the issues.
2023-03-24 16:29:16 +00:00
Otherwise, same as above._
2018-08-14 12:48:17 +00:00
2021-08-01 13:15:57 +00:00
- ::DEFECT [07293](#tbd) Player skips on very loud playback.
2018-08-14 12:48:17 +00:00
- ::WORKAROUND: Limit volume to settings 1 through 9.
2021-08-01 13:15:57 +00:00
- ::DEFECT [10509](#tbd) Cannot switch directly from random play mode to
2023-03-24 16:29:16 +00:00
Internet play-list.
2021-08-01 13:15:57 +00:00
- ::WORKAROUND: Switch to local play-list first. Click [here](#tbd) for
2023-03-24 16:29:16 +00:00
detailed instructions.
2021-08-01 13:15:57 +00:00
- ::DEFECT [10589](#tbd) Static heard while booting
- ::DEFECT [10944](#tbd) Repeat-mode cannot play more than 999 times