Skip to content

Commit

Permalink
Version 1.0.0
Browse files Browse the repository at this point in the history
Update version number and publish documentation.
  • Loading branch information
fadden committed Dec 28, 2023
1 parent 13e5fed commit aa03936
Show file tree
Hide file tree
Showing 12 changed files with 56 additions and 40 deletions.
2 changes: 1 addition & 1 deletion AppCommon/GlobalAppVersion.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public static class GlobalAppVersion {
/// Overall application version.
/// </summary>
public static readonly CommonUtil.Version AppVersion =
new CommonUtil.Version(1, 0, 0, CommonUtil.Version.PreRelType.Alpha, 1);
new CommonUtil.Version(1, 0, 0, CommonUtil.Version.PreRelType.Final, 0);
// NOTE: there's an independent version in DiskArc/Defs.cs
}
}
2 changes: 1 addition & 1 deletion DiskArc/Defs.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public static class Defs {
/// DiskArc library version number.
/// </summary>
public static CommonUtil.Version LibVersion { get; } =
new CommonUtil.Version(1, 0, 0, CommonUtil.Version.PreRelType.Alpha, 1);
new CommonUtil.Version(1, 0, 0, CommonUtil.Version.PreRelType.Final, 0);

public const string BUILD_TYPE =
#if DEBUG
Expand Down
24 changes: 12 additions & 12 deletions Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ or use one of these links to download a recent stable release:

System | Self-Cont'd? | Link
------------- | ------------ | ----
Windows x86 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0-alpha1/cp2_1.0.0-alpha1_win-x86_fd.zip
Windows x86 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0-alpha1/cp2_1.0.0-alpha1_win-x86_sc.zip
Windows x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0-alpha1/cp2_1.0.0-alpha1_win-x64_fd.zip
Windows x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0-alpha1/cp2_1.0.0-alpha1_win-x64_sc.zip
Mac OS x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0-alpha1/cp2_1.0.0-alpha1_osx-x64_fd.zip
Mac OS x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0-alpha1/cp2_1.0.0-alpha1_osx-x64_sc.zip
Linux x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0-alpha1/cp2_1.0.0-alpha1_linux-x64_fd.zip
Linux x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0-alpha1/cp2_1.0.0-alpha1_linux-x64_sc.zip
Windows x86 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_win-x86_fd.zip
Windows x86 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_win-x86_sc.zip
Windows x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_win-x64_fd.zip
Windows x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_win-x64_sc.zip
Mac OS x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_osx-x64_fd.zip
Mac OS x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_osx-x64_sc.zip
Linux x64 | no | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_linux-x64_fd.zip
Linux x64 | yes | https://github.com/fadden/CiderPress2/releases/download/v1.0.0/cp2_1.0.0_linux-x64_sc.zip

Once downloaded, unzip the file somewhere convenient (Safari on the Mac will do the unzip
for you). There is no installer; the commands are executed directly from where they are unzipped.
Expand Down Expand Up @@ -62,7 +62,7 @@ The commands are:
- `CiderPress2`: desktop graphical interface (Windows builds only)

The download includes the manual for cp2, `Manual-cp2.md`, formatted for 80 columns for ease
of viewing in a terminal window. The file is in "markdown" format, which is perfectly readable
of viewing in a terminal window. The file is in "Markdown" format, which is perfectly readable
as a plain text file. The manual for the GUI, and tutorials for both applications, can
be found on the [web site](https://ciderpress2.com/).

Expand All @@ -76,8 +76,8 @@ The CiderPress II command-line utility was developed on x64 CPUs with:

Compatibility is determined mostly by the .NET runtime, so more recent versions of the operating
systems are expected to work. Older versions of the operating systems may or may not work. For
example, the CLI application has been successfully run on Windows 7 32-bit, but this will not be
tested regularly.
example, the CLI application has been successfully run on Windows 7 32-bit (x86), but this will
not be tested regularly.

The code is targeted to .NET Core 6, and is expected to work on newer versions of the runtime.

Expand All @@ -87,7 +87,7 @@ The contents of the framework-dependent download packages for different systems
entirely identical. The application itself is compiled to platform-agnostic bytecode. Each
platform has a system-specific "cp2" executable that gets the runtime up and pointed in the
right direction. The only significant difference is between 32-bit code and 64-bit code; you
cannot run a 64-bit package on a 32-bit system.
cannot run a 64-bit package on a 32-bit runtime.

If you want to run the command-line app on a platform that doesn't have a system-specific
binary on the Releases page, you need to install the .NET runtime for your system, and then
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# CiderPress II #

### **This is alpha-quality software. Use at your own risk.**

CiderPress II is a software tool for working with disk images and file archives associated
with vintage Apple computers, notably the Apple II line and early Macintoshes. It runs on
modern desktop and embedded systems.
Expand All @@ -15,9 +13,10 @@ as copy and replace whole disk partitions.
For installation instructions, see the [install guide](Install.md).

**Current status:**
- The command-line and desktop GUI tools are alpha quality. The command-line tool is available
for Windows, macOS, and Linux, but the GUI tool currently only runs on Windows.
- Video demos, made during development:
- The command-line tool runs on Windows, macOS, and Linux (anywhere .NET Core 6 runs).
- The desktop GUI runs only on Windows.
- Video demos:
- v1.0 quick introduction: https://youtu.be/ZrUfNzscq3g
- v0.4 drag & drop: https://youtu.be/P2kss3aOEvs
- v0.3 disk handling: https://youtu.be/5tE07owhcCc
- v0.2 new GUI: https://www.youtube.com/watch?v=esEHP6Bo8GI
Expand Down
14 changes: 14 additions & 0 deletions SourceNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,17 @@ Since I don't know what the right answer is, I'm going to forge ahead with the
WPF version. This will ensure that the various APIs work correctly with a GUI
app, and demonstrate how I think the tool should behave. Fortunately, the GUI
application code is a relatively small part of the overall package.

## Source Code Division ##

As of v1.0, the division of code between components is approximately:

- 4% generic libraries (CommonUtil)
- 54% app-specific libraries (DiskArc, FileConv, AppCommon)
- 14% library tests (DiskArcTests and FileConvTests)
- 13% CLI (includes regression tests)
- 13% WPF GUI
- 1% miscellaneous (Examples, MakeDist)

(Based on Lines of Executable Code, from Visual Studio's "Calculate Code
Metrics" feature.)
4 changes: 2 additions & 2 deletions docs/Manual-cp2.md
Original file line number Diff line number Diff line change
Expand Up @@ -1231,8 +1231,8 @@ Short single-hyphen equivalents are provided for a few of the options:
- `-ph` = `--preserve=host`
- `-pn` = `--preserve=naps`

These may be provided singly or in a single chunk, e.g. "-pnfj" is equivalent
to "-pn -f -j".
These may be provided singly or as a single chunk, e.g. `-pnfj` is equivalent
to `-pn -f -j`.

#### `--classic`

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ handful of top-level documents (like the project README and installation
instructions) are copied out of the `top` directory.

Some text variable substitutions can be performed on HTML and Markdown files
as they are copied, e.g. all occurrences of `1.0.0-alpha1` will be replaced with
as they are copied, e.g. all occurrences of `1.0.0` will be replaced with
the current app version. This is used to update the links in the download
instructions (`Install.md`) to point at the current release.

Expand Down
3 changes: 3 additions & 0 deletions docs/cli-tutorial/extract.html
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,9 @@ <h3>Attribute Preservation</h3>
<p class="showout">extracting Docs/TeachTest
extracting Docs/TeachTest (rsrc) -> Docs\._TeachTest
</p>
<p>Use <kbd>-pa</kbd> for AppleSingle, <kbd>-pd</kbd> for AppleDouble,
<kbd>-pn</kbd> for NAPS, <kbd>-ph</kbd> for host filesystem (Mac OS only),
or <kbd>-p0</kbd> for no preservation (the default).</p>

<h3>Selection With Wildcards</h3>

Expand Down
3 changes: 3 additions & 0 deletions docs/gui-manual/dragcopy.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,9 @@ <h2>Drag / Copy Between Applications</h2>
images by opening the first image, copying the data, closing it, and then opening the second image
to do the paste.</p>

<p>If you copy a disk image or file archive that is contained within another archive and is
currently open in the Archive tree, it will be closed automatically when copied.</p>

<p>The application has no ability to influence how Windows Explorer handles the clipboard data
prepared for "foreign" transfers, so the file data must be arranged in the clipboard in a way that
allows it to be written to Windows without further action. This requires separating data and
Expand Down
6 changes: 4 additions & 2 deletions docs/gui-tutorial/add.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,9 @@ <h3>Import</h3>
but the files are assumed to be in a "modern" format. Attribute preservation
is ignored, and a file converter is applied.</p>
<p>Unlike export, import has no "best conversion" mode. You must specify
the converter to use, with the <samp>Conversion Mode</samp> pop-up menu.</p>
the converter to use, with the <samp>Conversion Mode</samp> pop-up menu.
For example, if you drag a text file in, you might want it to be treated
as a text file or as source for an Applesoft BASIC program.</p>
</div>
</div>

Expand All @@ -158,7 +160,7 @@ <h3>Import</h3>
<img src="images/import-conv-opts.png" alt="import-conv-opts"/>
</div>
<div class="grid-item-text">
<p>The options used for file imports can be set by clicking on the
<p>The options used for file import converters can be set by clicking on the
<samp>Conversion Settings</samp> button in the Add/Import Options area.
Pick the conversion mode from the pop-up menu at the top, configure
the desired options, and click <samp>Done</samp>.</p>
Expand Down
25 changes: 10 additions & 15 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,9 @@ <h4>Key features:</h4>
<li>Works directly with physical hard drives and removable media.</li>
<li>Provides file converters for many document, graphic, and code files.</li>
</ul>
<p>See <a href="features.html">this page</a> for a complete list of supported
<p>A brief (3-minute) <a href="https://youtu.be/ZrUfNzscq3g">introductory video</a>
is available.
See <a href="features.html">this page</a> for a complete list of supported
file formats and conversions.</p>
<p>
<a href="images/cp2-wpf-sample.png"><img src="images/cp2-wpf-sample-small.png" width="320" height="180" alt="sample"/></a>
Expand All @@ -103,25 +105,18 @@ <h4>Key features:</h4>

<p>
<a href="https://github.com/fadden/CiderPress2/releases/latest">
<b>Download</b> the latest release (1.0.0-alpha1)</a> from github.</p>
<b>Download</b> the latest release (1.0.0)</a> from github.</p>

<p>Some short video demos, made during development:</p>
<ul>
<li><a href="https://youtu.be/P2kss3aOEvs">v0.4 drag &amp; drop</a></li>
<li><a href="https://youtu.be/5tE07owhcCc">v0.3 disk handling</a></li>
<li><a href="https://www.youtube.com/watch?v=esEHP6Bo8GI">v0.2 new GUI</a></li>
<li><a href="https://www.youtube.com/watch?v=_jDVdC6-eoA">v0.1 CLI/GUI</a></li>
</ul>

<h4>Open Source</h4>
<p>CiderPress II is written in C# .NET, using the (free to download)
Visual Studio Community 2022 IDE as the primary development environment.
The GUI uses the Windows Presentation Foundation (WPF) API.</p>
<p>The full source code is available on
<h4>Free Software</h4>
<p>The full source code for CiderPress II is available on
<a href="https://github.com/fadden/ciderpress2">github</a>, distributed under
the Apache 2.0 license, which allows use of the code in both commercial and
non-commercial projects.</p>

<p>The code is written in C# .NET, using the (free to download)
Visual Studio Community 2022 IDE as the primary development environment.
The GUI uses the Windows Presentation Foundation (WPF) API.</p>

<p>As part of this project, documentation was created for all of the supported
archive, disk image, and vintage file formats. These are included with the
source code, and can be accessed from the
Expand Down
2 changes: 1 addition & 1 deletion ndocs/publish.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@


# Current version string. Used for text substitution.
app_version = "1.0.0-alpha1"
app_version = "1.0.0"
pkg_version = app_version

# ----- nothing configurable below -----
Expand Down

0 comments on commit aa03936

Please sign in to comment.