Apple-2-Tools/diskii
1
0
Fork 0
mirror of https://github.com/zellyn/diskii.git synced 2024-11-22 15:30:48 +00:00
Code Issues Projects Releases Wiki Activity

Update README to mention library goals

Browse Source
This commit is contained in:
Zellyn Hunter 2016-11-12 22:41:03 -05:00 committed by GitHub
parent 844ea47435
commit c7cb3bb5ce
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -3,21 +3,28 @@ diskii
diskii is a commandline tool for working with Apple II disk images. diskii is a commandline tool for working with Apple II disk images.
It is also a library of code that can be used by other Go programs.
Its major advantage is that it's written in Go, hence cross-platform. Its major advantage is that it's written in Go, hence cross-platform.
Its major disadvantage is that it mostly doesn't exist yet. Its major disadvantage is that it mostly doesn't exist yet.
[![Build Status](https://travis-ci.org/zellyn/diskii.svg?branch=master)](https://travis-ci.org/zellyn/diskii) [![Build Status](https://travis-ci.org/zellyn/diskii.svg?branch=master)](https://travis-ci.org/zellyn/diskii)
Eventually, it aims to be a comprehensive disk image manipulation It rhymes with “whiskey”.
tool, but for now only the `applesoft decode` command works.
It is pronounced so as to rhyme with "whiskey".
Discussion/support is in Discussion/support is in
[#apple2 on the retrocomputing Slack](https://retrocomputing.slack.com/messages/apple2/) [#apple2 on the retrocomputing Slack](https://retrocomputing.slack.com/messages/apple2/)
(invites [here](https://retrocomputing.herokuapp.com)). (invites [here](https://retrocomputing.herokuapp.com)).
### Goals
Eventually, it aims to be a comprehensive disk image manipulation
tool, but for now only the `applesoft decode` command works.
The library code aims (a) to support the commandline tool operations, and (b) to replace the "read and write disk images" code of the [goapple2 emulator](https://github.com/zellyn/goapple2).
### Installing/updating ### Installing/updating
Assuming you have Go installed, run `go get -u github.com/zellyn/diskii` Assuming you have Go installed, run `go get -u github.com/zellyn/diskii`
@ -26,7 +33,7 @@ Assuming you have Go installed, run `go get -u github.com/zellyn/diskii`
- [ ] Build per-platform binaries for Linux, MacOS, Windows - [ ] Build per-platform binaries for Linux, MacOS, Windows
- [ ] Implement CATALOG, deletion, and creation of files in DOS 3.3 images - [ ] Implement CATALOG, deletion, and creation of files in DOS 3.3 images
### Similar tools ### Related tools
- http://a2ciderpress.com/ - http://a2ciderpress.com/
- http://applecommander.sourceforge.net/ - http://applecommander.sourceforge.net/