diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 64cfbde..6c343d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ First off, we thank you for taking the time to contribute to the universal resou When contributing or submitting pull requests follow these guidelines or your contribution will not be taken seriously. -If you want to contribute but don't know what to do, see TODO.txt for a list of tasks that need to be complete, but make sure when you complete one you mark it as such, do not remove it from the list. +If you want to contribute but don't know what to do, see TODO for a list of tasks that need to be complete, but make sure when you complete one you mark it as such, do not remove it from the list. ## Make sure your code is - Functional diff --git a/README.md b/README.md index e69de29..a879804 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,13 @@ +# Universal System Monitor + +A universal and cross platform utility to monitor system health and control pheripherals. + +The goal of this project is to bring together the tens of software utilities that exist to monitor system health, hardware statistics and pheripheral control, cosmetic or otherwise in one neat cross platform package. + +Currently being developed for Linux and Windows 10. + +Contributions are welcome and encouraged, but not neccesary. See CONTRIBUTING.md for more info. And TODO for current developments. + +## Maintainers + +- Ben (plane000)#8618 - Founder, maintainer diff --git a/TODO b/TODO new file mode 100644 index 0000000..d90e9fb --- /dev/null +++ b/TODO @@ -0,0 +1,11 @@ +CURRENT TODO LIST FOR THE DEVELOPMENT OF THE UNIVERSAL RESOURCE MONITOR + +x -> complete +- -> depreciated / not doing +? -> in development + +***URGENT FIX NEEDED*** +[ ] + +**TODO** +[ ]