summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
index 17adf48..94ba24c 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,31 @@
 # brainf_rs
 
 Brainfuck interpreter written in Rust.
+
+## MSRV
+
+Requires nightly due to usage of the test feature.
+
+## Functionality
+
+This interpreter has multiple engine types. While these work in most cases, the
+input instruction on these engines (and probably the u8 engine) doesn't function
+as intended. If a program does not rely on this instruction, it should work fine.
+
+## License Notice
+
+brainf_rs is a brainfuck interpreter with multi-engine support written in Rust.
+Copyright (C) 2024  Sophie Forrest
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.