salfter/fluxengine
1
0
Fork 0
mirror of https://github.com/davidgiven/fluxengine.git synced 2025-10-31 11:17:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #468 from JohnVeness/JohnVeness-fix-docs

Browse Source 
Fix various doc typos
This commit is contained in:
David Given
2022-02-24 22:16:48 +00:00
committed by GitHub
parent 30957f4105 d6faf5b074
commit 8250112c7f
8 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -2,7 +2,7 @@ FluxEngine
==========
(If you're reading this on GitHub, the formatting's a bit messed up. [Try the
version on cowlark.com instead.](http://cowlark.com/fluxengine/)
version on cowlark.com instead.](http://cowlark.com/fluxengine/))
**Breaking news!** As of 2021-05-21, the command line environment has changed
_substantially_ (to make it more consistent and flexible, and allow some new
@@ -149,7 +149,7 @@ at least, check the CRC so what data's there is probably good.
There hasn't been a lot of demand for this yet; if you have a pressing
need to write weird disks, [please
ask](https://github.com/davidgiven/fluxengine/issues/new). I haven't
implement write support for PC disks because they're boring and I'm lazy,
implemented write support for PC disks because they're boring and I'm lazy,
and also because they vary so much that figuring out how to specify them
is hard.

2
doc/building.md
View File

@@ -231,7 +231,7 @@ You should now have a working board, so it's time to test it.
have a single 3.5" connector, after the twist.)
If you have **two** drives, plug them into both connectors. FluxEngine,
sadly, non-standard disk numbering (there are reasons). Drive 0 is the
sadly, uses non-standard disk numbering (there are reasons). Drive 0 is the
one nearest the motherboard; that is, before the twist. Drive 1 is the
one at the end of the cable; that is, after the twist. Drive 0 is the
default. You can tell the client to select drive 1 by using `-s :d=1`.

4
doc/disk-acornadfs.md
View File

@@ -16,8 +16,8 @@ Tested ones are:
I expect the others to work, but haven't tried them; [get in
touch](https://github.com/davidgiven/fluxengine/issues/new) if you have any
news. For ADFS S (single sided 40 track) you'll want `--heads 0 --cylinders
0-79x2`. For ADFS M (single sided 80 track) you'll want `--heads 0`.
news. For ADFS S (single-sided 40 track) you'll want `--heads 0 --cylinders
0-79x2`. For ADFS M (single-sided 80 track) you'll want `--heads 0`.
Be aware that Acorn logical block numbering goes all the way up side 0 and
then all the way up side 1. However, FluxEngine uses traditional disk images

2
doc/disk-acorndfs.md
View File

@@ -5,7 +5,7 @@ Acorn DFS disks are pretty standard FM encoded IBM scheme disks, with
256-sectors and 0-based sector identifiers. There's nothing particularly
special here.
DFS disks are all single sided, but allow the other side of the disk to be
DFS disks are all single-sided, but allow the other side of the disk to be
used as another drive. FluxEngine supports these; read one side at a time
with `--heads 0` or `--heads 1`.

4
doc/disk-aeslanier.md
View File

@@ -11,8 +11,8 @@ of nearly £50,000 in 2018!).
processing software off twin 5.25" drive units, but apparently other software
was available.
The disk format is exceptionally weird. They used 77 track, 32 sector, single
sided _hard_ sectored disks, where there were multiple index holes,
The disk format is exceptionally weird. They used 77 track, 32 sector, single-sided
_hard_ sectored disks, where there were multiple index holes,
indicating to the hardware where the sectors start. The encoding scheme
itself is [MMFM (aka
M2FM)](http://www.retrotechnology.com/herbs_stuff/m2fm.html), an early

6
doc/disk-ibm.md
View File

@@ -3,8 +3,8 @@ Disk: Generic IBM
IBM scheme disks are _the_ most common disk format, ever. They're used by a
huge variety of different systems, and they come in a huge variety of different
forms, but they're all fundamentally the same: either FM or MFM, either single
or double sided, with distinct sector header and data records and no sector
forms, but they're all fundamentally the same: either FM or MFM, either single-
or double-sided, with distinct sector header and data records and no sector
metadata. Systems which use IBM scheme disks include but are not limited to:
- IBM PCs (naturally)
@@ -133,7 +133,7 @@ Neither the FluxEngine or Greaseweazle hardware can currently command a
tri-mode drive to spin at 360rpm, however an older 360rpm-only drive will work
to read these formats.
Alternately, the FluxEngine software can resale the flux pulses to enable
Alternately, the FluxEngine software can rescale the flux pulses to enable
reading and writing these formats with a plain 300rpm drive. To do this,
specify the following two additional options:

2
doc/disk-micropolis.md
View File

@@ -12,7 +12,7 @@ the Vector Graphic Dual-Mode Disk Controller which was paired with a Tandon
drive.
**Important note:** You _cannot_ read these disks with a normal PC drive, as
these drives are 96tpi.The track spacing is determined by the physical geometry
these drives are 96tpi. The track spacing is determined by the physical geometry
of the drive and can't be changed in software. You'll need to get hold of a
100tpi Micropolis drive. Luckily these seem to use the same connector and
pinout as a 96tpi PC 5.25" drive. In use they should be identical.

14
doc/using.md
View File

@@ -43,7 +43,7 @@ file while changing the decoder options, to save disk wear. It's also much faste
### Connecting it up
To use, simply plug your FluxEngine (or [GreaseWeazle](greaseweazle.doc) into
To use, simply plug your FluxEngine (or [GreaseWeazle](greaseweazle.md)) into
your computer and run the client. If a single device is plugged in, it will be
automatically detected and used.
@@ -82,7 +82,7 @@ $ fluxengine read eco1 -s copy.flux -o eco1.ldbs --cylinders=1
### Configuration
Configuration options are reperesented as a hierarchical structure. You can
Configuration options are represented as a hierarchical structure. You can
either put them in a text file and load them from the command line:
```
@@ -262,18 +262,18 @@ FluxEngine also supports a number of file system image formats. When using the
Read from a [DIM image file](https://www.pc98.org/project/doc/dim.html),
commonly used by X68000 emulators. Supports automatically configuring
the encoder. **Read Only.**
the encoder. **Read only.**
- `<filename.fdi>`
Read from a [FDI image file](https://www.pc98.org/project/doc/hdi.html),
commonly used by PC-98 emulators. Supports automatically configuring
the encoder. **Read Only.**
the encoder. **Read only.**
- `<filename.d88>`
Read from a [D88 image file](https://www.pc98.org/project/doc/d88.html),
commonly used by various Japanese PC emulators, including the NEC PC-88. **Read Only.**
commonly used by various Japanese PC emulators, including the NEC PC-88. **Read only.**
FluxEngine is currently limited to reading only the first floppy image in a
D88 file.
@@ -284,7 +284,7 @@ FluxEngine also supports a number of file system image formats. When using the
- `<filename.nfd>`
Read from a [NFD r0 image file](https://www.pc98.org/project/doc/nfdr0.html),
commonly used by various Japanese PC emulators, including the NEC PC-98. **Read Only.**
commonly used by various Japanese PC emulators, including the NEC PC-98. **Read only.**
Only r0 version files are currently supported.
@@ -308,7 +308,7 @@ FluxEngine also supports a number of file system image formats. When using the
underlying MFM, FM or GCR stream, without actually doing the decode into
user-visible bytes. However, the decode is still done in order to check for
correctness. Individual records are separated by three `\\0` bytes and tracks
are seperated by four `\\0` bytes; tracks are emitted in CHS order.
are separated by four `\\0` bytes; tracks are emitted in CHS order.
### High density disks