knghtbrd
commented
8 years ago For an actual release, there's a mechanism for publishing release notes as part of the GitHub release process. Since this is a draft, that seems like a good solution. That or perhaps a wiki page, which is what I've done with some of the stuff you posted as info good to have around, but needn't be an issue.. Either can be marked up using Markdown (BTW, do you use Markdown for anything else, have a nice cheatsheet etc?)
The third possibility is to adopt the convention of a NEWS(.txt) file containing the relevant release notes for the latest version.
The latter two options have the advantage of being version-controlled. An open issue lends itself to commentary on the process that the other options don't. Which suggests a fourth possibility: One of the other options for editing of a draft along with an issue to discuss the changes.
No major preferences in any direction, just presenting options. :)
IvanExpert
I don't know where else to put these so I'm putting them here for now. They should be probably be incorporated into README.md and whatever final release notes go with 1.3.0, which I'll think about later provided what I've done here makes sense and you don't think needs reworking. Version 1.2.8 is not an actual release, though it is "releasable". I've designated it as such on the way to 1.3.0 (which might be 1.5.0).
A2SERVER 1.2.8 release notes
Important: the default URL for binaries (ivanx.com/a2server/files) probably does not work, and until I clean that up on the web host for the 1.3.0 release, you'll need to use the new alternate binary server described below.
PRELIMINARY JESSIE SUPPORT
The installer can be run on Debian 8 and Raspbian "Jessie". (It could before, but it would install untested libraries and compile for them, which was much slower.)
64-BIT SUPPORT
64-bit Debian 7 (Wheezy) and Debian 8 (Jessie) precompiled binaries are available and supported.
TCP/IP OVER APPLETALK (MacIP) SUPPORT
The MacIPgw package, contributed by Jason King based on work by Stefan Bethke, allows for IIgs and classic Mac computers to connect to the Internet over LocalTalk by using MacIP.
ALTERNATE HOSTING FOR BINARIES
New A2SERVER_BINARY_URL variable supports hosting binaries elsewhere, including locally. It would usually contain "${A2SERVER_SCRIPT_URL}files/". A tarball containing the expected contents of this folder is at http://ivanx.com/a2server/files/dist/binaries.tar.gz. See below for an outline of the expected files.
External dependencies (i.e. source code, older Debian packages, Apple II software) can be self-hosted. They need to go in "${A2SERVER_BINARY_URL}external/". A tarball containing the full contents of this folder is at http://ivanx.com/a2server/files/dist/external.tar.gz -- see below for an outline of the expected files.
If present, self-hosted external dependencies are automatically used as a fallback in case of failure when attempting to get the resources from external sites. This "fallback" can be preferred (that is, the external sites aren't tried) by exporting A2SERVER_NO_EXTERNAL=1.
(There is at present no error checking for what happens if the fallback fails; you'll just get a broken install.)
OFFLINE INSTALL
Using locally hosted binaries and external dependencies, it's possible to install completely offline if dependent packages have been previously installed, as follows.
If precompiled binaries are available:
Wheezy: unzip libgnustep-base1.22 libdb5.1 libgcrypt11 libssl1.0.0 attr fuse libglib2.0-0 libattr1 libfuse2
Jessie: unzip unar libdb5.3 libgcrypt20 libssl1.0.0 attr fuse libglib2.0-0 libattr1 libfuse2
If precompiled binaries are not available:
Wheezy: unzip build-essential zlib1g-dev libgnustep-base-dev libz-dev libbz2-dev libssl-dev libicu-dev libdb5.1-dev libgcrypt11-dev libglib2.0-dev libattr1-dev libfuse-dev
Jessie: unzip unar build-essential zlib1g-dev unzip libssl-dev libdb5.3-dev libgcrypt11-dev libglib2.0-dev libattr1-dev libfuse-dev
EXTERNAL SUBDIRECTORY
A completely populated external subdirectory, as of 1.2.8, contains the following files, which expand from external.tar.gz. A production tarball for developers would omit Apple_II_System_Disk_3.2.sea.bin, and the GS/OS installer disks; these could be added manually by the developer, with the names specified below.
(click Edit to see these hierarchically as they're supposed to be, pending markdown reformatting.) external: appleii: Apple_II_System_Disk_3.2.sea.bin Asimov.shk dsk2file.shk gshk11.sea gsos601: Disk_1_of_7-Install.sea.bin Disk_2_of_7-System.Disk.sea.bin Disk_3_of_7-SystemTools1.sea.bin Disk_4_of_7-SystemTools2.sea.bin Disk_5_of_7-Fonts.sea.bin Disk_6_of_7-synthLAB.sea.bin Disk_7_of_7-Apple_II_Setup.sea.bin gsos602: Fonts1.po Fonts2.po Install.po synthLAB.po System.Disk.po SystemTools1.po SystemTools2.po SystemTools3.po gsos603: Fonts.po Install.po synthLAB.po System.Disk.po SystemTools1.po SystemTools2.po MOUNTIT.SHK shrinkit.sdk spectrum: spectrum_extras.2mg spectrum_gold_2mg.zip spectrum_manuals.2mg spectrum_sounds.2mg spectrum.2mg deb: libdb5.1_5.1.29-5_amd64.deb libdb5.1_5.1.29-5_armhf.deb libdb5.1_5.1.29-5_i386.deb libdb5.1-dev_5.1.29-5_amd64.deb libdb5.1-dev_5.1.29-5_armhf.deb libdb5.1-dev_5.1.29-5_i386.deb libgcrypt11_1.5.0-5+deb7u3_amd64.deb libgcrypt11_1.5.0-5+deb7u3_armhf.deb libgcrypt11_1.5.0-5+deb7u3_i386.deb libgcrypt11-dev_1.5.0-5+deb7u3_amd64.deb libgcrypt11-dev_1.5.0-5+deb7u3_armhf.deb libgcrypt11-dev_1.5.0-5+deb7u3_i386.deb source: ciopfs-0.4.tar.gz macipgw-src.zip netatalk-2.2.4.tar.gz nulibdist.tar.gz unar-1.8.zip
REORGANIZED FILES (BINARIES) SUBDIRECTORY
The following items are expected in the binaries folder, and are in the tarball binaries.tgz. The "precompiled" folder, or some subset of it, is optional; the items outside of it are not. If items in the precompiled folder are not found at install time, they will be compiled from source obtained from an external or self-hosted URL.
files: A2CLOUD.DSK A2CLOUD.HDV A2FILES-list.txt appletalk-3.2.27+-rpi.ko.gz appletalk-3.6.11+-rpi.ko.gz appletalk-3.12.22+-rpi.ko.gz FARALLON.B1.BXY FARALLON.B1.PO macip-prefs.tgz netatalk-init.d-clean.txt netatalk-maketar.txt precompiled: appletalk-3.2.0-4-486-debian_x86.tgz appletalk-3.2.0-4-amd64-debian_x64.tgz appletalk-3.16.0-4-586-debian_x86.tgz appletalk-3.16.0-4-amd64-debian_x64.tgz ciopfs-debian_x64.tgz ciopfs-debian_x86.tgz ciopfs-rpi.tgz macipgw-debian_x64.tgz macipgw-debian_x86.tgz macipgw-rpi.tgz netatalk224-debian_x64.tgz netatalk224-debian_x86.tgz netatalk224-rpi.tgz nulib2-debian_x64.tgz nulib2-debian_x86.tgz nulib2-rpi.tgz unar-debian_x64.tgz unar-debian_x86.tgz unar-rpi.tgz
1.2.7: Case insensitive file system for A2FILES; existing is converted and GSFILES is removed if empty Preliminary Jessie support A2SERVER_SCRIPT_URL variable allows for installation from different site [had been available post 1.2.4, but only from Joseph's codebase] Unification of Ivan's and Joseph's codebases
1.2.6: Full installation of Spectrum during netboot installation.