This commit is contained in:
nora 2022-07-04 16:08:42 +02:00
parent f7e862a8fd
commit 578582951e
3 changed files with 14 additions and 10 deletions

View file

@ -1,14 +1,9 @@
[[section-system-scope-and-context]]
== System Scope and Context
[plantuml]
----
(crapderive) --- User : Terminal
----
=== Technical Context
**<Diagram or Table>**
**<optionally: Explanation of technical interfaces>**
**<Mapping Input/Output to Channels>**
The user interacts with crapderive via a terminal and standard input and output.

View file

@ -8,5 +8,11 @@ The code is available on GitHub (https://github.com/Nilstrieb/crapderive). The u
To build and install crapderive, they can run the following command if they have Rust installed:
`cargo install --git https://github.com/Nilstrieb/crapderive`.
[plantuml]
----
(Github) -- User1 : cargo install
(Github) -- User2 : git clone
----
=== Installing Rust
To install Rust, visit https://www.rust-lang.org/tools/install.

View file

@ -4,6 +4,7 @@
* Parser tests
* Idiomatic Rust code
* Good diagnostics
* Performance
=== Quality Tree
@ -16,6 +17,7 @@ left to right direction
(Quality) --> (usability)
(usability) --> (3 diagnostics)
(usability) --> (4 performance)
----
=== Quality Scenarios
@ -26,4 +28,5 @@ left to right direction
|1|A developer wants to add a new feature to the parser. It should be ensured that they don't break existing functionality.
|2|A new developer that is already familiar with rust wants to get started contributing to the project. The project should be familiar to them.
|3|Someone wants to use crapderive, but they have syntax errors since they aren't familiar with the language yet. The compiler should help them find the issues and fix them.
|4|A user wants to rewrite their slow bash script in a faster language. Crapderive should give them this capability.
|===