Update READMEs

This commit is contained in:
Matt Harlum 2023-04-23 19:05:37 +00:00
parent 3c8e5aeabf
commit 83e0231039
5 changed files with 72 additions and 5 deletions

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# CIDER Software
This repository contains software utilities for the [CIDER](https://github.com/LIV2/CIDER) CDTV Expansion
## Contents
- [addram](https://github.com/LIV2/CIDER-Software/tree/main/addram) Adds the A0/Bonus RAM to the system
- [bootrom](https://github.com/LIV2/CIDER-Software/tree/main/bootrom) A Kickstart module to add the Bonus RAM to the system at boot
- [cflash](https://github.com/LIV2/CIDER-Software/tree/main/cflash) A tool to manage the Kick Flash and update the IDE ROM
- [iderom](https://github.com/LIV2/CIDER-Software/tree/main/iderom) The IDE device driver ROM
## Downloading
Binaries are provided under [Releases](https://github.com/LIV2/CIDER-Software/releases)
* CIDER-IDE-Update.adf is a bootable floppy image that will update the IDE to the latest firmware version
* CIDER-Software.adf and CIDER-Software.lha contain binaries for the tools in this repositiory
## Third-Party notice
iderom - reloc.S: reloc.S is adapted from the [A4091](https://github.com/A4091/a4091-software) open-source driver and is Copyright Stefan Reinauer
liv2ride.device: mounter.c is adapted from the [A4091](https://github.com/A4091/a4091-software) open-source driver and is Copyright 2021-2022 Toni Wilen
## License
All software contained that is not provided by a third-party is covered by a GPL 2.0 Only license
[![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
CIDER and it's software are licensed under the GPL-2.0 only license

View File

@ -10,3 +10,8 @@ A tool to add the BonusRAM ($A0000) to the system
-p <priority> - Set Fast / BonusRAM Priority
```
## License
[![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
addram is licensed under the GPL-2.0 only license

View File

@ -7,4 +7,10 @@ This will automatically add the $A0000 RAM to your system's memory pool if Fast
If the Left mouse-button is held at boot it will not run
## Usage
Add to your extended rom using Remus or Romtool
Add to your extended rom using Remus/Romtool or use with loadmodule
## License
[![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
BootROM is licensed under the GPL-2.0 only license

View File

@ -1,8 +1,20 @@
# CFLASH
A tool to program the Kickstart and IDE Flash of the CIDER board.
This tool allows you to program the Kick and IDE flash in-system even while it is currently in use
## Usage
## Usage examples
### Copying current kickstart and extended rom to flash
```cflash -C -c```
### Flashing IDE ROM
```cflash -I cider-ide.rom```
### Flashing a kickstart file to the second slot
```cflash -s 1 -k kick13.rom```
## Command-line options
```
Usage: cflash [-iEvV] [-e k|x] [-c|-k <kickstart rom>] [-C|-x <extended rom>] [-I <ide rom>] -s [0|1]
-c - Copy ROM to Flash.
@ -16,4 +28,10 @@ Usage: cflash [-iEvV] [-e k|x] [-c|-k <kickstart rom>] [-C|-x <extended rom>] [-
-v - Verify bank against file or ROM
-V - Skip verification after programming.
-s [0|1] - Select kickstart slot to work on.
```
```
## License
[![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
cflash is licensed under the GPL-2.0 only license

View File

@ -1,3 +1,17 @@
## ide boot rom
## IDE BootROM
WIP for the IDE driver
Autobooting IDE ROM, compatible with kick 1.3 and up
This rom contains [liv2ride.device](https://github.com/LIV2/liv2ride.device)
The latest binary can be found under [releases](https://github.com/LIV2/CIDER-Software/releases)
You can install the latest version by booting the CIDER-IDE-Update.adf disk image
## Third-Party notices
iderom: reloc.S is adapted from the [A4091](https://github.com/A4091/a4091-software) open-source driver and is Copyright Stefan Reinauer
liv2ride.device: mounter.c is adapted from the [A4091](https://github.com/A4091/a4091-software) open-source driver and is Copyright 2021-2022 Toni Wilen
## License
All software contained that is not provided by a third-party is covered by a GPL 2.0 Only license
[![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)