Skip to content

Commit ce32e62

Browse files
author
ynn
committed
docs: updates README.md
1 parent db96fda commit ce32e62

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Interpreter for [*Piet Programming Language*](https://www.dangermouse.net/esoter
1414

1515
### 2.1 Installation
1616

17+
MSRV(Minimum Supported Rust Version): [Rust 1.81.0](https://www.rust-lang.org/tools/install)
18+
1719
#### From GitHub
1820

1921
```bash
@@ -69,7 +71,7 @@ Our implementation marks any unknown color as an error, immediately terminating
6971

7072
> *Individual pixels of colour are significant in the language, so it is common for programs to be enlarged for viewing so that the details are easily visible. In such enlarged programs, the term "codel" is used to mean a block of colour equivalent to a single pixel of code, to avoid confusion with the actual pixels of the enlarged graphic, of which many may make up one codel.*
7173
72-
The codel size is automatically detected or can be specified via `--codel-size` option. Note that, generally speaking, the codel size cannot be uniquely determined. If a positive integer `n` is valid as a codel size, then any divisors of `n` are also valid. It is even known there is a program whose behavior changes as the codel size changes (see [*Multi-Codel Size*](https://www.dangermouse.net/esoteric/piet/samples.html)). When automatic detection is performed, the maximum valid `n` is adopted.
74+
The codel size is automatically detected or can be specified via `--codel-size` option. Note that, generally speaking, the codel size cannot be uniquely determined. If a positive integer `n` is valid as a codel size, then any divisor of `n` is also valid. It is even known there is a program whose behavior changes as the codel size changes (see [*Multi-Codel Size*](https://www.dangermouse.net/esoteric/piet/samples.html)). When automatic detection is performed, the maximum valid `n` is used.
7375

7476
### 3.3 Stack
7577

@@ -123,7 +125,7 @@ Many unit tests are written.
123125

124126
As integration tests, almost all of the samples exhibited in [*Piet Program Gallery*](https://www.dangermouse.net/esoteric/piet/samples.html) are tested.
125127

126-
Some tests are set `#[ignore]` (i.e. skipped) because they fail. As far as we investigated, we suspect the reason is not because our implementation is wrong but because some samples are not standard-compliant (anymore). Especially, how white blocks shall be handled was not clarified in the first version of the spec, and it was afterwards clarified as seen in the latest spec. Our implementation conforms to [*the spec as of 2023/03/29*](https://web.archive.org/web/20230327044126/https://www.dangermouse.net/esoteric/piet.html).
128+
Some tests are set `#[ignore]` (i.e. skipped) because they fail. As far as we investigated, we suspect the reason is not because our implementation is incorrect but because some samples are not standard-compliant (anymore). In particular, how white blocks shall be handled was not clarified in the first version of the spec, and it was afterwards clarified as seen in the latest spec. Our implementation conforms to [*the spec as of 2023/03/29*](https://web.archive.org/web/20230327044126/https://www.dangermouse.net/esoteric/piet.html).
127129

128130
## 5. References
129131

0 commit comments

Comments
 (0)