diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 55 |
1 files changed, 24 insertions, 31 deletions
@@ -2,49 +2,42 @@ flint (**F**uck **L**anguage **INT**erpeter) is a collection of interpeters and compiliers for various esoteric programming languages. -Languages that flint currently supports: +## Languages -There are currently no implemented languages +### Languages that flint currently supports: -Languages that flint is currently planning to support: +* brainfuck: core functionality supported, not very robust yet + +### Languages that flint is currently planning to support: -* brainfuck (currently in development) * Thue ## Installation -TODO: Write installation instructions here +1. Clone this repository: `git clone https://git.matthewhall.xyz/flint.git` +2. Checkout the `main` branch: `cd flint && git checkout main` +3. Compile with `shards build --production` +4. Move or link the `bin/flint` executable somewhere in your `$PATH` ## Usage 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 - -TODO: Write development instructions here - -## Contributing - -1. Fork it (<https://github.com/your-github-user/flint/fork>) -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create a new Pull Request +``` +Basic usage: flint [LANGUAGE] [OPTIONS] [FILE] + brainfuck select brainfuck as the language + -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 +``` ## Contributors |