summaryrefslogtreecommitdiff
path: root/README.md
blob: 6965fba58ff3c17517aa66038cfaa381f37e0176 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# flint

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

TODO: Write installation instructions here

## 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

## Contributors

- [Matthew Hall](gemini://matthewhall.xyz) - creator and maintainer