49 lines
2.0 KiB
Markdown
49 lines
2.0 KiB
Markdown
<!--
|
|
Copyright (C) 2024 - 2024:
|
|
The Trinitrix Project <bpeetz@b-peetz.de, antifallobst@systemausfall.org>
|
|
SPDX-License-Identifier: MIT
|
|
|
|
This file is part of Trinitrix.
|
|
|
|
Permission is hereby granted, free of charge, to any person
|
|
obtaining a copy of this software and associated documentation files
|
|
(the “Software”), to deal in the Software without restriction,
|
|
including without limitation the rights to use, copy, modify, merge,
|
|
publish, distribute, sublicense, and/or sell copies of the Software,
|
|
and to permit persons to whom the Software is furnished to do so,
|
|
subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be
|
|
included in all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
OTHER DEALINGS IN THE SOFTWARE.
|
|
-->
|
|
|
|
# Design Philosophy
|
|
|
|
## Customizability
|
|
|
|
Trinitrix aims to be highly customizable.
|
|
The command API provides a customizazion method, which can be used by an initial config script or live from the intern cli 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 users are nerdy linux users xD.
|
|
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 only use case.
|
|
They should be open for every usecase, that makes sense.
|
|
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.
|