Skip to content

Commit

Permalink
attempt 2 at fixing readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rafa-br34 committed Apr 5, 2024
1 parent 6b43cbd commit 4c256af
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Placeholder
#### `-x` & `-y`:
Canvas width/height
### `-m`:
Defines a state machine, can later be used when defining a ant with `-a`. Can be chained using `;`
Example:
- `-m LRRRRRLLR;RLLLLLRRL`: Creates two state machines with index 0 and 1
Defines a state machine, can later be used when defining a ant with `-a`. Can be chained using `;`
Example:
`-m LRRRRRLLR;RLLLLLRRL`: Creates two state machines with index 0 and 1
#### `-a`:
Defines ants using the following format `P(X,Y)D(DX,DY)M(M)S(S)F(W?)` which can be chained using `;`
- `P` Initial position
Expand All @@ -34,14 +34,14 @@ Defines ants using the following format `P(X,Y)D(DX,DY)M(M)S(S)F(W?)` which can
- `S` Defines the step size
- `F` Optional section that defines flags (W: Wrap)

Example usage:
- `-a P(500,500)D(0,-1)M(RL)`: Creates a single ant with the state machine `RL`
- `-a P(500,500)D(0,-1)M(0)S(10)F(W);P(500,500)D(0,1)M(1)`: Creates two ants using state machine 0 and 1, ant 0 wraps and has a step size of 10
Example:
`-a P(500,500)D(0,-1)M(RL)`: Creates a single ant with the state machine `RL`
`-a P(500,500)D(0,-1)M(0)S(10)F(W);P(500,500)D(0,1)M(1)`: Creates two ants using state machine 0 and 1, ant 0 wraps and has a step size of 10
#### `-i`:
Defines how many iterations should be evaluated, by default it will run until all ants run out of bounds or (if wrap is enabled) will run indefinitely. Alternatively it can be specified as time to signal that it should run based on time instead of iterations.
Example usage:
- `-i i50b`: Run for 50 billion iterations
- `-i t100s`: Run a maximum of 100 seconds
Defines how many iterations should be evaluated, by default it will run until all ants run out of bounds or (if wrap is enabled) will run indefinitely. Alternatively it can be specified as time to signal that it should run based on time instead of iterations.
Example:
`-i i50b`: Run for 50 billion iterations
`-i t100s`: Run a maximum of 100 seconds
#### `-s`:
Defines when a canvas snapshot should be taken. Can be chained using `;`
- `i<interval?>`: Snapshots every `interval` iterations (if not specified 1 is assumed)
Expand Down

0 comments on commit 4c256af

Please sign in to comment.