Docs(Philosophy): Added a WIP design philosophy for the project.

This commit is contained in:
antifallobst 2023-07-20 00:40:21 +02:00
parent dfeac4662d
commit 36ab50b467
Signed by: antifallobst
GPG Key ID: 2B4F402172791BAF
1 changed files with 16 additions and 0 deletions

16
docs/Philosophy.md Normal file
View File

@ -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.