add readme, fix contributing

This commit is contained in:
HorizonCode 2022-08-08 14:45:34 +02:00
parent c8c316ce4e
commit b2eec1be05
2 changed files with 10 additions and 1 deletions

View File

@ -1,5 +1,5 @@
# Contributing # Contributing
Thank you for wanting to contribute to the development for theta! Please keep the following in mind when contributing to this repository please keep all of the following in mind as it will prevent headaches in the future Thank you for wanting to contribute to the development of SysBackup! Please keep the following in mind when contributing to this repository please keep all of the following in mind as it will prevent headaches in the future
## Code style ## Code style
- Constants are to be written using SCREAMING_SNAKE_CASE - Constants are to be written using SCREAMING_SNAKE_CASE

9
README.md Normal file
View File

@ -0,0 +1,9 @@
# SysBackup
This branch is a rewrite of the [previous in Java Developed branch](https://git.ez-pp.farm/HorizonCode/SysBackup/src/branch/archived), rewritten in NodeJS.
### Requirements
- NodeJS 16 `(only tested version yet)`
### Contributing
Please read our [CONTRIBUTING.md](https://git.ez-pp.farm/HorizonCode/SysBackup/src/branch/master/CONTRIBUTING.md) to read how to contribute!