This repository has been archived on 2024-05-26. You can view files and clone it, but cannot push or open issues or pull requests.
core/docs/Philosophy.md

41 lines
1.7 KiB
Markdown
Raw Normal View History

<!--
Copyright (C) 2024 - 2024:
The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
SPDX-License-Identifier: GPL-3.0-or-later
This file is part of Trinitrix.
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your option)
any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program.
If not, see <https://www.gnu.org/licenses/>.
-->
# Design Philosophy
## Customizability
Trinitrix aims to be highly customizable.
2023-07-19 22:59:47 +00:00
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.
2023-07-19 22:59:47 +00:00
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
2023-07-19 22:59:47 +00:00
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.