summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorSophie Forrest <git@sophieforrest.com>2024-08-30 23:55:06 +1200
committerSophie Forrest <git@sophieforrest.com>2024-08-30 23:55:06 +1200
commita36f999ae05c42e639b5ce1566b7dcfe9445baea (patch)
tree88f457bf2b3c469ad70a5db2c522534ed9846031 /README.md
parent3c163eabc78ddbd26bb250ef5ad6da28cd61adc6 (diff)
chore: license under AGPL
All previous commits are to be considered licensed under the GNU
AGPL-3.0-or-later (SPDX-License-Identifier: AGPL-3.0-or-later).
Diffstat (limited to 'README.md')
-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/>.