Skip to content

Commit f4bb153

Browse files
committed
update readme
1 parent a7a527a commit f4bb153

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

README.MD

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# JFunge
2+
23
A standard-conforming Funge-98 interpreter.
34

45
### Usage
6+
57
`jfunge [file] [--3d] [--version] [--license]`
68

79
| argument | usage |
@@ -12,17 +14,29 @@ A standard-conforming Funge-98 interpreter.
1214
| `--license` | Prints the license of the program. |
1315
| `--maxiter <number>` | The maximum number of iterations the program can run for. Anything less than 1 will run until the program terminates naturally. |
1416

15-
### References
16-
- [Esolang wiki article of Funge-98](https://esolangs.org/wiki/Funge-98)
17-
- [Official funge98 language specification](https://github.com/catseye/Funge-98/blob/master/doc/funge98.markdown)
18-
- [Mycology Befunge-98 test suite](https://github.com/Deewiant/Mycology)
17+
### Compatibility
18+
19+
The interpreter's handprint is `0xfa15e9a7` (`-99227225` in decimal), which is a hexadecimal approximation of "`falsepat`" from FalsePattern.
1920

20-
### Currently implemented fingerprints
21+
The version number given to befunge is `major * 256 * 256 + minor * 256 + patch`, where major, minor, patch are the 3
22+
primary version numbers in the standard semver format.
23+
24+
The interpreter supports the following Funge-98 specification extensions:
25+
- The entire Befunge base syntax (tested against Mycology and Mycorand)
26+
- Buffered IO
27+
- File IO with `i` and `o`
28+
- System calls with `=` (paradigm 1, `system()`-like)
29+
- Concurrency (pseudo-multithreading) with `t`
30+
- Optional Trefunge mode (experimental)
31+
32+
Additionally, the following fingerprints are currently supported (more to come):
2133
- [MODE](https://catseye.tc/view/funge-98/library/MODE.markdown)
2234
- [MODU](https://catseye.tc/view/funge-98/library/MODU.markdown)
2335
- [NULL](https://catseye.tc/view/funge-98/library/NULL.markdown)
2436
- [ROMA](https://catseye.tc/view/funge-98/library/ROMA.markdown)
2537

26-
### Additional goals
27-
- [x] File IO
28-
- [x] Concurrency
38+
### References
39+
40+
- [Esolang wiki article of Funge-98](https://esolangs.org/wiki/Funge-98)
41+
- [Official funge98 language specification](https://github.com/catseye/Funge-98/blob/master/doc/funge98.markdown)
42+
- [Mycology Befunge-98 test suite](https://github.com/Deewiant/Mycology)

0 commit comments

Comments
 (0)