aboutsummaryrefslogtreecommitdiff
path: root/reqs.toml
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-09-19 17:30:24 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-09-19 17:30:24 +0200
commitfe7588d21d4adb85dbd8fe951ae65610e9f8866c (patch)
tree3271938da644036fe0fef9aaf596718c619e53c1 /reqs.toml
parent8fd427d11c3b78e90409eddf42af2417b833ef34 (diff)
parent41ac21680ef13e2db543ff56728ecffe504d6850 (diff)
merge `master` into `loek/research`loek/research
Diffstat (limited to 'reqs.toml')
-rw-r--r--reqs.toml29
1 files changed, 12 insertions, 17 deletions
diff --git a/reqs.toml b/reqs.toml
index 2da91ac..ed0b451 100644
--- a/reqs.toml
+++ b/reqs.toml
@@ -1,15 +1,10 @@
# This is a TOML file containing all project requirements. The reqs2tex script
# can be used to generate the files necessary to compile requirements.tex and
# cross-reference the requirements from other documents.
-#
-# Note that TOML has a hash table structure, so keys used for defining
-# requirement properties cannot be used for requirement IDs. The properties are:
-# label, type, id, index, deleted, done, description, priority
# This is the requirement cross-reference ID. Requirements can be
-# (cross-)referenced from LaTeX by prefixing this ID with `req:` and
-# substituting dots for colons (i.e. this requirement is referenced as
-# \cref{req:audio:async-api}).
+# (cross-)referenced from LaTeX by prefixing this ID with `req:` (i.e. this
+# requirement is referenced as \cref{req:audio}).
[audio]
# Requirement type ('system' | 'user')
type = 'user'
@@ -25,10 +20,10 @@ background music, while simultaniously playing sound effects.
# is a list of strings, each item is treated as the ID of another requirement,
# and the references are checked before LaTeX runs.
done = [
- 'audio.async-api',
- 'audio.handle',
- 'audio.stream-mix',
- 'audio.volume',
+ 'audio:async-api',
+ 'audio:handle',
+ 'audio:stream-mix',
+ 'audio:volume',
]
#done = 'When I feel like it'
# Requirements that are no longer applicable should set `deleted` to `true`.
@@ -36,7 +31,7 @@ done = [
# different document revisions.
#deleted = true
-[audio.async-api]
+[audio:async-api]
type = 'system'
priority = 'must'
description = '''
@@ -44,7 +39,7 @@ The public audio \gls{api} supports starting audio samples asynchronously
(i.e.~fire and forget).
'''
-[audio.handle]
+[audio:handle]
type = 'system'
priority = 'must'
description = '''
@@ -52,14 +47,14 @@ The public audio \gls{api} allows the game programmer to control (i.e.~play,
pause, resume and stop) audio samples after they are created/initialized.
'''
-[audio.stream-mix]
+[audio:stream-mix]
type = 'system'
priority = 'must'
description = '''
The audio system supports playing multiple audio streams simultaniously.
'''
-[audio.volume]
+[audio:volume]
type = 'system'
priority = 'must'
description = '''
@@ -69,7 +64,7 @@ audio samples.
# TODO: audio encoding support?
-[lib.license]
+[lib:license]
type = 'system'
priority = 'must'
description = '''
@@ -77,7 +72,7 @@ External libraries must have a license that is MIT-compatible, or one that
allows linking against MIT code.
'''
-[lib.platform]
+[lib:platform]
type = 'system'
priority = 'must'
description = '''