diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 28 insertions, 3 deletions
@@ -1,6 +1,15 @@ # flint -TODO: Write a description here +flint (**F**uck **L**anguage **INT**erpeter) is a collection of interpeters and compiliers for various esoteric programming languages. + +Languages that flint currently supports: + +There are currently no implemented languages + +Languages that flint is currently planning to support: + +* brainfuck (currently in development) +* Thue ## Installation @@ -8,7 +17,22 @@ TODO: Write installation instructions here ## Usage -TODO: Write usage instructions here +Subject to change as this is a very early version of the pogram, but this is what it will probably be: + +Basic usage: `flint [LANGUAGE] [OPTIONS] [FILE]` + +With no FILE, or when FILE is -, read code from STDIN. + +General options: + + `-i`, `--interpret`, interpet the provided source code, 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 + +Language-specific options: + +Brainfuck: + + `-t N`, `--tape-size=N`, specify the number of memoy cells in the tape, defaults to 30,000 ## Development @@ -24,4 +48,5 @@ TODO: Write development instructions here ## Contributors -- [Matthew Hall](https://github.com/your-github-user) - creator and maintainer +- [Matthew Hall](gemini://matthewhall.xyz) - creator and maintainer + |