From 966bdaeb102b20955ef74f3246ccd9c1070d208e Mon Sep 17 00:00:00 2001
From: Matthew Hall <hallmatthew314@gmail.com>
Date: Mon, 29 Aug 2022 18:13:46 +1200
Subject: Some boring stuff

---
 .gitignore   |  2 ++
 README.md    | 31 ++++++++++++++++++++++++++++---
 src/flint.cr |  6 ++++++
 3 files changed, 36 insertions(+), 3 deletions(-)

diff --git a/.gitignore b/.gitignore
index 0bb75ea..0eb34d3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,5 @@
 /bin/
 /.shards/
 *.dwarf
+/test_programs
+/test_programs/**
diff --git a/README.md b/README.md
index 16cf336..6965fba 100644
--- a/README.md
+++ b/README.md
@@ -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
+
diff --git a/src/flint.cr b/src/flint.cr
index 48d6d30..4434118 100644
--- a/src/flint.cr
+++ b/src/flint.cr
@@ -3,4 +3,10 @@ module Flint
   VERSION = "0.1.0"
 
   # TODO: Put your code here
+  def self.main
+    puts "Hello world!"
+  end
 end
+
+Flint.main
+
-- 
cgit v1.2.1