Skip to content

Commit

Permalink
tweak docs, readme, add gitattributes
Browse files Browse the repository at this point in the history
  • Loading branch information
dfgordon committed Aug 11, 2024
1 parent 0a812a3 commit 33312e4
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
completions/* linguist-vendored=true
tests/** linguist-detectable=false
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# a2kit

Command line interface and library for manipulating retro disk images, file systems, and languages, with emphasis on Apple II.
Command line interface and library for retro disk images, file systems, and languages, with emphasis on Apple II.

* Designed to be scriptable
* Languages - Applesoft, Integer BASIC, Merlin Assembly
- syntax comprehension, complete LSP support coming with v3
- tokenization, detokenization
* Language Servers - Applesoft, Integer BASIC, Merlin Assembly
- deep analysis, tokenization, disassembly, follows LSP
* File Systems - Apple DOS 3.x, ProDOS, CP/M, Pascal, FAT (such as MS-DOS)
- full read and write access
- high or low level manipulations
Expand Down
4 changes: 2 additions & 2 deletions src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const IN_HELP: &str = "if disk image is piped, omit `--dimg` option";
pub fn build_cli() -> Command {
let long_help = "a2kit is always invoked with exactly one of several subcommands.
The subcommands are generally designed to function as nodes in a pipeline.
PowerShell users may need to wrap the pipeline in a native shell.
PowerShell users should use version 7.4 or higher to avoid lots of trouble.
Set RUST_LOG environment variable to control logging level.
levels: trace,debug,info,warn,error
Expand Down Expand Up @@ -95,7 +95,7 @@ Detokenize from image: `a2kit get -f prog -t atok -d myimg.dsk | a2kit detokeniz
.required(true);

let mut main_cmd = Command::new("a2kit")
.about("Manipulates retro files and disk images with emphasis on Apple II.")
.about("Retro languages and disk images with emphasis on Apple II.")
.after_long_help(long_help)
.version(crate_version!());

Expand Down
5 changes: 3 additions & 2 deletions src/fs/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
//! File systems are represented by the `DiskFS` trait. The trait object takes ownership of
//! some disk image, which it uses as storage. Files are represented by a `FileImage`
//! object. This is a low level representation of the file that works for any of the supported
//! file systems. File image data is processed through the `Packing` trait. The trait object
//! is returned by the `FileImage::packer` method.
//! file systems. File image data is processed through the `Packing` trait. There are
//! convenience functions in `DiskFS` such as `read_text`, which gets a file image and unpacks it
//! as text, or `write_text`, which packs text into a file image and puts it.
//!
//! This module also contains the `Block` enumeration, which specifies and locates allocation units.
//! The enumeration names the file system's allocation system, and its value is a specific block.
Expand Down

0 comments on commit 33312e4

Please sign in to comment.