forked from trinitrix/core
docs: added initial docs (README, LICENSE, commit message style)
This commit is contained in:
parent
ff8a6e66eb
commit
9253966139
|
@ -0,0 +1,20 @@
|
|||
Copyright 2023 The Trinitrix Project <antifallobst@systemausfall.org>
|
||||
|
||||
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.
|
|
@ -0,0 +1,27 @@
|
|||
# Trinitrix
|
||||
Trinitrix is a terminal UI client for the matrix chat protocol.
|
||||
Docs can be found [here](https://git.nerdcult.net/antifallobst/trinitrix/src/branch/master/docs).
|
||||
|
||||
---
|
||||
|
||||
# License (MIT)
|
||||
Copyright 2023 The Trinitrix Project <antifallobst@systemausfall.org>
|
||||
|
||||
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.
|
|
@ -0,0 +1,29 @@
|
|||
# Commit message style
|
||||
|
||||
Commit messages have to align with the following style:
|
||||
|
||||
`<type> (<space>): <change>`
|
||||
|
||||
Pull requests that don't align with this style probably won't be accepted.
|
||||
|
||||
## type
|
||||
The type of change to be committed.
|
||||
|
||||
Possible values:
|
||||
- __feature__ - When you added a new feature or functionality.
|
||||
- __fix__ - When you fixed a bug or stuff like that.
|
||||
- __docs__ - When you wrote documentation or changed the readme. The space field is optional here.
|
||||
- __refactor__ - When you restructured the codebase / parts of it. The space field is optional here.
|
||||
|
||||
If your commit has multiple types, think about splitting it into multiple commits.
|
||||
This helps others (and you) to understand changes in retrospect.
|
||||
|
||||
## space
|
||||
The space that is affected by the commit.
|
||||
|
||||
## change
|
||||
What you've changed. / The actual commit message.
|
||||
|
||||
# Examples
|
||||
- `feature (AHCI): implemented port initialization`
|
||||
- `fix (processes): changed process spawning to copy the null terminator at the end of the name`
|
Loading…
Reference in New Issue