Add 'COPYING' file with the GPLv2 licens
[platform/adaptation/setup-scripts.git] / README
1 The documentaion can be found here:
2 https://wiki.tizen.org/wiki/IVI/artem-setup-ivi
3
4 Some coding style notes for the shell scripts
5 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6
7 1. Do not use bashisms, install 'dash' and use it to verify that the
8    scripts are free of bashisms.
9
10 2. Do not use all capitals for variables
11
12 3. For shared files, prefix all symbols which are not supposed to be
13    used from outside with "__".
14
15 4. Be consistent with my style. If you see that something makes no sense
16    or could be improved, change that globally.
17
18 5. All the error and verbose output should go to stderr
19
20 6. Use -- to separate options and arguments, this is generally a good defensive
21    programming practice to make sure no one tricks your commands by adding
22    options to what should be arguments. E.g., 'rm $file' can be made 'rm -rf /"
23    if one makes "$file" to be "-rf /" somehow. 'rm -- $file' would catch this.
24 --
25 Artem Bityutskiy