Skip to content

Commit 6730eac

Browse files
committed
+ update description
1 parent 643bb65 commit 6730eac

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,35 @@
11
# go-ascii-animator
22

3-
Yet another tool to animate your Ascii graphics
3+
Yet another tool to animate your Ascii graphics.
44

55
## Build
66

7-
`go build main.go`
7+
`go build go-ascii-animator.go`
88

99
## Run
1010

11+
Use help:
12+
1113
```
12-
./main -h
14+
./go-ascii-animator -h
1315
14-
Usage of ./main:
15-
-d float
16-
Frame delay (default 0.5)
16+
Usage of ./go-ascii-animator:
17+
-d duration
18+
Delay between frames (milliseconds) (default 500ns)
1719
-f string
1820
File with ASCII graphics to animate
19-
-l If the animation should loop
21+
-l If the animation should loop”
22+
```
23+
24+
Example:
25+
26+
```
27+
./go-ascii-animator -d 1000 -f samples/cat.txt -l
2028
```
2129

2230
## ASCII files format
2331

24-
`[yeaa]` at the end of each block
32+
- `[yaaa]` at the end of each block
33+
- `[end]` at the end of the file
34+
35+
You can also see examples in samples/ folder.

go-ascii-animator.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
)
1313

1414
func main() {
15-
var frameDelay = flag.Duration("d", 500, "Frame delay (milliseconds)")
15+
var frameDelay = flag.Duration("d", 500, "Delay between frames (milliseconds)")
1616
var filename = flag.String("f", "", "File with ASCII graphics to animate")
1717
var loop = flag.Bool("l", false, "If the animation should loop")
1818

0 commit comments

Comments
 (0)