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

Spell (and capitalise) Greaseweazle correctly.

Browse Source
This commit is contained in:
David Given
2023-05-25 19:50:05 +02:00
parent 2bef6ca646
commit 53adcd92ed
12 changed files with 54 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/drives.md
View File

@@ -42,7 +42,7 @@ done by adding the special profile `40track_drive`:
fluxengine write ibm360 40track_drive -i image.img -d drive:0
```
It should then Just Work. This is supported by both FluxEngine and GreaseWeazle
It should then Just Work. This is supported by both FluxEngine and Greaseweazle
hardware.
Obviously you can't write an eighty-track format using a forty-track drive!
@@ -63,7 +63,7 @@ The FluxEngine client supports these with the `apple2_drive` profile:
fluxengine write apple2 apple2_drive -i image.img -d drive:0
```
This is supported only by GreaseWeazle hardware.
This is supported only by Greaseweazle hardware.
Shugart drives
--------------
@@ -86,5 +86,5 @@ fluxengine write atarist720 shugart_drive -i image.img -d drive:0
(If you have a 40-track Shugart drive, use _both_ `shugart_drive` and
`40track_drive`.)
This is supported only by GreaseWeazle hardware.
This is supported only by Greaseweazle hardware.

18
doc/greaseweazle.md
View File

@@ -1,10 +1,10 @@
Using the FluxEngine client software with GreaseWeazle hardware
Using the FluxEngine client software with Greaseweazle hardware
===============================================================
The FluxEngine isn't the only project which does this; another one is the
[GreaseWeazle](https://github.com/keirf/Greaseweazle/wiki), a Blue Pill based
[Greaseweazle](https://github.com/keirf/Greaseweazle/wiki), a Blue Pill based
completely open source solution. This requires more work to set up (or you can
buy a prebuilt GreaseWeazle board), but provides completely open source
buy a prebuilt Greaseweazle board), but provides completely open source
hardware which doesn't require the use of the Cypress Windows-based tools that
the FluxEngine does. Luckily, the FluxEngine software supports it almost
out-of-the-box --- just plug it in and nearly everything should work. The
@@ -16,10 +16,10 @@ FluxEngine makes things complicated when you're not using the FluxEngine client
software with a FluxEngine board, but I'm afraid it's too late to change that
now. Sorry.
**If you are using GreaseWeazle-compatible hardware** such as the
**If you are using Greaseweazle-compatible hardware** such as the
[adafruit-floppy](https://github.com/adafruit/Adafruit_Floppy) project, then
FluxEngine will still work; however, as the USB VID/PID won't be that of a real
GreaseWeazle, the the FluxEngine client can't autodetect it. Instead, you'll
Greaseweazle, the the FluxEngine client can't autodetect it. Instead, you'll
need to specify the serial port manually with something like
`--usb.greaseweazle.port=/dev/ttyACM0` or `--usb.greaseweazle.port=COM5`.
@@ -32,7 +32,7 @@ Driver box says `WinUSB` and the right one says `USB Serial (CDC)`. Then press
What works
----------
Supported features with the GreaseWeazle include:
Supported features with the Greaseweazle include:
- simple reading and writing of disks, seeking etc
- erasing disks
@@ -59,12 +59,12 @@ Who to contact
--------------
I want to make it clear that the FluxEngine code is _not_ supported by the
GreaseWeazle team. If you have any problems, please [contact
Greaseweazle team. If you have any problems, please [contact
me](https://github.com/davidgiven/fluxengine/issues/new) and not them.
In addition, the GreaseWeazle release cycle is not synchronised to the
In addition, the Greaseweazle release cycle is not synchronised to the
FluxEngine release cycle, so it's possible you'll have a version of the
GreaseWeazle firmware which is not supported by FluxEngine. Hopefully, it'll
Greaseweazle firmware which is not supported by FluxEngine. Hopefully, it'll
detect this and complain. Again, [file an
issue](https://github.com/davidgiven/fluxengine/issues/new) and I'll look into
it.

4
doc/technical.md
View File

@@ -80,11 +80,11 @@ as you need an adapter cable or board, but this will allow you to replicate the
FluxEngine hardware on a $2 Blue Pill.
I am _not_ planning on replacing the PSoC5 with a Blue Pill, because someone
already has: [the GreaseWeazle](https://github.com/keirf/Greaseweazle/wiki) is
already has: [the Greaseweazle](https://github.com/keirf/Greaseweazle/wiki) is
a completely open source firmware package which will read and write Supercard
Pro files via a standard Blue Pill or via a prebuilt board. It's supported by
the FluxEngine client software, and you should, mostly, be able to use
GreaseWeazle hardware interchangeably with FluxEngine hardware. See the
Greaseweazle hardware interchangeably with FluxEngine hardware. See the
[dedicated page](greaseweazle.md) for more information.

2
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.md)) 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.