linspector/monipy
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Some README fixes.

Browse source
This commit is contained in:
Johannes Findeisen 2022-09-24 22:39:05 +02:00
commit 999c74459f
1 changed files with 20 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -17,17 +17,15 @@ nearly does not exist.
### Manifest ### Manifest
- All of this project **must be MIT licensed**. When using 3rd party libraries make - All of this project **must be MIT licensed**. When using 3rd party libraries make
sure the license is compatible but MIT should always be preferred if an sure the license is compatible but MIT should always be preferred if an
alternative is available. alternative is available.
- The core of monipy/monipyd should not use 3rd party libraries. only plugins,
- The core of monipy/monipyd should not use 3rd party libraries. only plugins, notifications and types may use other libraries. But coping code into the
notifications and types may use other libraries. But coping code into the source tree is ok when respecting the license. Not using 3rd party libraries
source tree is ok when respecting the license. Not using 3rd party libraries should always be preferred though.
should always be preferred though. - Inline comment should be all lowercase. Descriptions and documentation comments
must be natural language.
- Inline comment should be all lowercase. Descriptions and documentation comments
must be natural language.
### To do ### To do
@ -36,22 +34,22 @@ at the moment!
### Version numbering ### Version numbering
According to: [https://wiki.unixpeople.org/linux_kernel_version_numbering]() According to: [https://wiki.unixpeople.org/linux_kernel_version_numbering](https://wiki.unixpeople.org/linux_kernel_version_numbering)
**MAJOR**.**FEATURE**.**MINOR**.**FIXES** **MAJOR**.**FEATURE**.**MINOR**.**FIXES**
- **MAJOR** changes _can_ change the API. The lesser, the better. - **MAJOR** changes _can_ change the API. The lesser, the better.
- **FEATURE** changes can, but _should_ not break the API. New features are placed - **FEATURE** changes can, but _should_ not break the API. New features are placed
here. It _expects_ a complete documentation. here. It _expects_ a complete documentation.
- **MINOR** changes are "just-in-time" changes or small enhancements which _must_ - **MINOR** changes are "just-in-time" changes or small enhancements which _must_
not affect the documentation and _must_ not break the API. not affect the documentation and _must_ not break the API.
- **FIXES** _must_ never affect anything else then stability or security. - **FIXES** _must_ never affect anything else then stability or security.
## License ## License
### MIT License ### MIT License
Copyright (c) 2022 Johannes Findeisen <you@hanez.org> Copyright (c) 2022 Johannes Findeisen - you@hanez.org
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal