From 36ab50b467fc00128888699992e0215debe645df Mon Sep 17 00:00:00 2001 From: antifallobst Date: Thu, 20 Jul 2023 00:40:21 +0200 Subject: [PATCH] Docs(Philosophy): Added a WIP design philosophy for the project. --- docs/Philosophy.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/Philosophy.md diff --git a/docs/Philosophy.md b/docs/Philosophy.md new file mode 100644 index 0000000..15d4e00 --- /dev/null +++ b/docs/Philosophy.md @@ -0,0 +1,16 @@ +# Design Philosophy + +## Customizability +Trinitrix aims to be highly customizable. +The command API provides a customizazion method, can be used by an initial config script and live by the user. +The command API should cover at least 90% of the possible configuration settings. + +## Cross Platform +Trinitrix is cross platform. +Even if the targeted user group are nerdy linux users. +This can be easily achieved by using only cross platform libraries such as `crossterm` or `tui`. + +## Future Proof / Extensible +Modules and Interfaces should be designed in a way, that they're not limited to one use case. +A good example is the command API, which is a unified way to interact with the application. +It can used via lua, but use cases like fetching commands using http are theoretically possible too.