summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 12 insertions, 13 deletions
diff --git a/README.md b/README.md
index a15c62a..70a58f0 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,21 @@
# flint
-flint (**F**uck **L**anguage **INT**erpeter) is a collection of interpeters and compiliers for various esoteric programming languages.
+flint (**F**unny **L**anguage **INT**erpeter) is a collection of interpeters and compiliers for various esoteric programming languages.
## Languages
### Languages that flint currently supports:
-* brainfuck: core functionality supported, not very robust yet
+* [brainfuck](https://esolangs.org/wiki/brainfuck): core functionality supported, not very robust yet
+* [Thue](https://esolangs.org/wiki/Thue): core functionality supported, special options yet to be implemented
+* [Among Us](https://esolangs.org/wiki/Among_Us): seems to work, but needs more testing
### Languages that flint is currently planning to support:
-* Thue (in progress)
+* [FALSE](https://esolangs.org/wiki/FALSE)
+* [0815](https://esolangs.org/wiki/0815)
+* [Underload](https://esolangs.org/wiki/Underload) (this one will take a while)
+* [ESOPUNK](https://esolangs.org/wiki/ESOPUNK)
## Installation
@@ -21,22 +26,16 @@ flint (**F**uck **L**anguage **INT**erpeter) is a collection of interpeters and
## Usage
-Subject to change as this is a very early version of the pogram, but this is what it will probably be:
+This probably won't be updated very often as this is a very early stage of development. With that said, here is what the usage is at the time of writing:
```
-Basic usage: flint [LANGUAGE] [OPTIONS] [FILE]
- brainfuck select brainfuck as the language
+Basic usage: flint [OPTIONS] [LANGUAGE] [FILE]
-h, --help show this help and exit
-i, --interpet interpet the provided source code, implied by default, overridden by '-c' or '--compile'
-c, --compile produce a binary or different source code file instead of interpeting the code, overrides an explicit '-i' or '--intepret' flag
--stdin read source code from STDIN instead of a file
-```
-
-## Language-specific options:
-
-### Brainfuck:
-```
- -t CELLS, --tape-size=CELLS specify the number of memory cells in the tape, defaults to 30,000
+ -m CELLS, --memory-size=CELLS specify the number of memory cells available, defaults vary depending on language
+ --supported-languages print a list of languages supported by flint and exit
```
## Contributors