Noratrieb/crapderive
1
0
Fork 0
mirror of https://github.com/Noratrieb/crapderive.git synced 2026-01-16 09:35:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc

Browse source
This commit is contained in:
nora 2022-06-27 12:08:21 +02:00
parent 4b2393850d
commit 7d120f7b5e
5 changed files with 49 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

19
doc/src/01_introduction_and_goals.adoc
View file

@ -1,22 +1,27 @@
[[section-introduction-and-goals]]
== Introduction and Goals
=== Requirements Overview
==== What is Crapderive?
Crapderive is a small assembly-like programming language. It's implemented as a Rust interpreter.
=== Quality Goals
* Ease of implementation: It must not be too complex to implement Crapderive, while still being interesting. A simpler language makes for a simpler implementation, which is easier to document.
* Interpreter UX: The interpreter must be easy to use, and should give clear error messages.
* Performance: While performance isn't a strict requirement, the interpreter should be decently fast.
=== Stakeholders
[options="header",cols="1,2,2"]
[options="header",cols="1,2"]
|===
|Role/Name|Contact|Expectations
| _<Role-1>_ | _<Contact-1>_ | _<Expectation-1>_
| _<Role-2>_ | _<Contact-2>_ | _<Expectation-2>_
|Role/Name|Expectations
| Teacher | An interesting programming language with good documentation.
| Other students | An interesting programming language they can try out and have fun with.
| Author | Get a good mark with it.
|===