Improve README

cc @rustdesk
This commit is contained in:
Daniel Hansson authored and GitHub committed 2023-10-06 10:53:46 +02:00
1 parent afe85342c9
commit d86b4bd7cd
1 file changed
+50 -2
+50 -2
View File
@@ -1,4 +1,52 @@
# rustdesk-server-pro # RustDesk Server PRO
Some scripts for RustDesk Server Pro are hosted here. Here we have a small collection of some scripts for RustDesk Server Pro.
> If you are looking for the open source version please go to [RustDesk Server](https://github.com/rustdesk/rustdesk-server) > If you are looking for the open source version please go to [RustDesk Server](https://github.com/rustdesk/rustdesk-server)
# Contributing to this repo
You are very welcome to add your PR to improve the current scripts. Some pointers:
### The lib file
The lib.sh is used to avoid duplicate code. Here we collect everything that occurs more than once in the varoius scripts. That could be both `functions()` and `$variables`.
### Indentation
We always use four (4) spaces, not one (1) tab. Please see below for examples.
### IF arguments and functions
The current style is to use it like this:
```
if something
then
do something
fi
```
Not like:
```
if something; then
do something
fi
```
Same applies for functions:
```
examplefuntion() [
if something
then
do something
fi
}
```
### Variables
Variables are always written in CAPITAL LETTERS.
```
EXAMPLEVARIABLE=true
```