7.0 KiB
7.0 KiB
<html>
<head>
</head>
Overview
Project Plan
Workflows
Current
<!-- Markdown content here -->
<h1 id="user-content-productname-xyz-release-notes" dir="auto">::PRODUCTNAME X.Y.Z: Release Notes</h1>
<hr>
<p dir="auto"><em>TODO: For each release, copy this file and fill in the needed
information.</em></p>
<p dir="auto"><em>TODO: Make sure to use the <strong>product</strong> name and <strong>external</strong> release
number, not internal information.</em></p>
<h5 id="user-content-product" dir="auto">Product:</h5>
<p dir="auto">::<a href="<a href="http://www.COMPANY.com/products/PRODUCTNAME/" class="link">http://www.COMPANY.com/products/PRODUCTNAME/</a>">PRODUCTNAME</a></p>
<h5 id="user-content-release-number" dir="auto">Release Number:</h5>
<p dir="auto">::X.Y.Z</p>
<h5 id="user-content-release-date" dir="auto">Release Date:</h5>
<p dir="auto">::YEAR/MONTH/DAY</p>
<h5 id="user-content-customer-support" dir="auto">Customer Support:</h5>
<p dir="auto">::For more information or support, please visit our
<a href="<a href="http://www.COMPANY.com/products/PRODUCTNAME/" class="link">http://www.COMPANY.com/products/PRODUCTNAME/</a>">website</a> or email us
at <a href="mailto:support@COMPANY.com">support@COMPANY.com</a></p>
<hr>
<h3 id="user-content-introduction" dir="auto">Introduction</h3>
<p dir="auto">::This document contains the release notes for PRODUCTNAME version X.Y.Z.
The following sections describe the release in detail and provide
late-breaking or other information that supplements the main
documentation.</p>
<p dir="auto"><em>TODO: Consider using one of the following example paragraphs.</em></p>
<p dir="auto">::This is a developer release for internal evaluation only. Please report
any issues via the internal issue tracker.</p>
<p dir="auto">::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.</p>
<p dir="auto">::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
possible. Keep in mind that we are continuing to work on PRODUCTNAME and
things may change in the future.</p>
<p dir="auto">::This is the first full release of this product. See the product website
for a complete description.</p>
<p dir="auto">::(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.</p>
<p dir="auto">::(WHEN Y IN VERSION NUMBER CHANGES) This is an upgrade release with some
significant enhancements. Users of previous releases are encouraged to
upgrade.</p>
<p dir="auto">::(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.</p>
<p dir="auto">::(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.</p>
<h3 id="user-content-whats-new" dir="auto">What's New?</h3>
<p dir="auto"><em>TODO: Briefly list major user-visible enhancements. Or, note that
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
information can be helpful.</em></p>
<ul dir="auto">
<li>::Added 4 new play-back modes</li>
<li>::Increased play-back speed by as much as 30%</li>
<li>::(FOR REUSABLE COMPONENTS ONLY) Streamlined build process</li>
<li>::(FOR REUSABLE COMPONENTS ONLY) Roughly doubled unit test coverage</li>
<li>::Many improvements to the product's quality, reliability, ease of
use, and performance. See "Recent Changes" below for details.</li>
</ul>
<h3 id="user-content-installation-and-upgrade-notes" dir="auto">Installation and Upgrade Notes</h3>
<p dir="auto"><em>TODO: Fill in these sections. The text here is only an example.</em></p>
<h4 id="user-content-installation" dir="auto">::Installation</h4>
<p dir="auto">::See the <a href="/Suborbital-Systems/ReadySetGit/src/commit/6387d954bed39e4570b280da6fafcd5e1201da4b/install.html">installation instructions</a> for full details.
Please note that in this release, ...</p>
<p dir="auto">::IMPORTANT: You must completely uninstall any previous "developer
release" or "early access" version of this product before installing
this release.</p>
<h4 id="user-content-manifest" dir="auto">::Manifest</h4>
<p dir="auto">::This release consists of the following items:</p>
<ul dir="auto">
<li>::Release notes (this file)</li>
<li>::Installation instructions / Quick start guide</li>
<li>::Product installer binary</li>
<li>::User guide</li>
<li>::Product source code and build instructions</li>
</ul>
<h3 id="user-content-minimum-system-requirements" dir="auto">::Minimum System Requirements</h3>
<h4 id="user-content-system-processor" dir="auto">::System Processor:</h4>
<p dir="auto">::800MHz</p>
<h4 id="user-content-system-memory" dir="auto">::System Memory:</h4>
<p dir="auto">::256MB</p>
<h4 id="user-content-free-disk-space" dir="auto">::Free Disk Space:</h4>
<p dir="auto">::10MB</p>
<h4 id="user-content-operating-system" dir="auto">::Operating System:</h4>
<p dir="auto">::Windows 2000, Windows XP, Mac OS X, Linux (kernel 2.4)</p>
<h4 id="user-content-networking" dir="auto">::Networking:</h4>
<p dir="auto">::Internet access</p>
<h4 id="user-content-existing-software" dir="auto">::Existing Software:</h4>
<ul dir="auto">
<li>::Standard e-mail client</li>
<li>::Popular web browser (IE6, NN7)</li>
<li>::SuperWaveEdit(TM) 2.0.2 (Needed for custom playback modes)</li>
</ul>
<h4 id="user-content-version-compatibility" dir="auto">::Version Compatibility:</h4>
<p dir="auto">::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.</p>
<h3 id="user-content-recent-changes" dir="auto">Recent Changes</h3>
<p dir="auto"><em>TODO: Query your public issue tracking system to produce a report of
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
proprietary information.</em></p>
<ul dir="auto">
<li>::FIX <a href="#user-content-">09823</a> Screen frozen when caps-lock is on</li>
<li>::FIX <a href="#user-content-">09912</a> Static heard while downloading</li>
<li>::FIX <a href="#user-content-">10923</a> Repeat-mode cannot play more than 99 times</li>
<li>::ENHANCEMENT <a href="#user-content-">08237</a> Scratch DJ-mode</li>
<li>::ENHANCEMENT <a href="#user-content-">08238</a> Chill DJ-mode</li>
<li>::ENHANCEMENT <a href="#user-content-">08259</a> Retro stereo-mode</li>
<li>::ENHANCEMENT <a href="#user-content-">10202</a> Techno-mode</li>
</ul>
<h3 id="user-content-known-problems-and-workarounds" dir="auto">Known Problems and Workarounds</h3>
<p dir="auto"><em>TODO: Query your public issue tracking system to produce a report of
defects discovered in this release, or in previous releases that are
still not resolved. Include information on workarounds from the issues.
Otherwise, same as above.</em></p>
<ul dir="auto">
<li>::DEFECT <a href="#user-content-">07293</a> Player skips on very loud playback.
<ul dir="auto">
<li>::WORKAROUND: Limit volume to settings 1 through 9.</li>
</ul>
</li>
<li>::DEFECT <a href="#user-content-">10509</a> Cannot switch directly from random play mode to
Internet play-list.
<ul dir="auto">
<li>::WORKAROUND: Switch to local play-list first. Click <a href="#user-content-">here</a> for
detailed instructions.</li>
</ul>
</li>
<li>::DEFECT <a href="#user-content-">10589</a> Static heard while booting</li>
<li>::DEFECT <a href="#user-content-">10944</a> Repeat-mode cannot play more than 999 times</li>
</ul>
<!-- End Markdown content -->
</html>