aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexis Roda <alexis.roda.villalonga@gmail.com>2019-08-06 21:59:00 +0200
committerJuan J. Martínez <jjm@usebox.net>2019-08-06 20:59:00 +0100
commit2faf74953a23837e02ad0977f870c94b5f8c37d8 (patch)
treea4f0b0f0c03a4e0823c06acddf413ada9cc746e5 /README.md
parent5b7817484b8bf1d0b52f9c3f8d5e3a3e8b16be46 (diff)
downloadz80count-2faf74953a23837e02ad0977f870c94b5f8c37d8.tar.gz
z80count-2faf74953a23837e02ad0977f870c94b5f8c37d8.zip
Improved comment alignment (#13)
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md
index 8a40780..71cc51f 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,13 @@ With `-s` the tool adds a subtotal.
By default `z80count` will try to update comments replacing existing annotations.
+Comments added by `z80count` are aligned to the column given in the
+`-c` (`--column`) option (50 by default). By default the comments are
+aligned using spaces, if you prefer tabs instead use the `--use-tabs`
+option. In order to compute the padding `z80count` assumes that a
+`TAB` equals 4 spaces. Use the option `-t` to override this.
+
+
Example:
```asm
push hl
@@ -91,7 +98,7 @@ Processed with `z80count.py -s` results in:
```asm
push hl ; [11 .. 11]
pop bc ; [10 .. 21]
- ld hl, $5800 ; [10 .. 31]
+ ld hl, $5800 ; [10 .. 31]
ld e, 7 ; [7 .. 38]
.fade_out_all_loop0
@@ -102,7 +109,7 @@ Processed with `z80count.py -s` results in:
.fade_out_all_loop1
ld a, (hl) ; [7 .. 71]
and 7 ; [7 .. 78]
- jr z, no_fade_all_ink ; [12/7 .. 90/85]
+ jr z, no_fade_all_ink ; [12/7 .. 90/85]
dec a ; [4 .. 89]
.no_fade_all_ink
@@ -110,7 +117,7 @@ Processed with `z80count.py -s` results in:
ld a, (hl) ; [7 .. 100]
and $38 ; [7 .. 107]
- jr z, no_fade_all_paper ; [12/7 .. 119/114]
+ jr z, no_fade_all_paper ; [12/7 .. 119/114]
sub 8 ; [7 .. 121]
.no_fade_all_paper
@@ -127,12 +134,12 @@ Processed with `z80count.py -s` results in:
dec bc ; [6 .. 166]
ld a, b ; [4 .. 170]
or c ; [4 .. 174]
- jr nz, fade_out_all_loop1 ; [12/7 .. 186/181]
+ jr nz, fade_out_all_loop1 ; [12/7 .. 186/181]
pop bc ; [10 .. 191]
pop hl ; [10 .. 201]
dec e ; [4 .. 205]
- jr nz, fade_out_all_loop0 ; [12/7 .. 217/212]
+ jr nz, fade_out_all_loop0 ; [12/7 .. 217/212]
```
Comments show subtotals, and there are two types: