Skip to content

Commit c281c25

Browse files
committed
#16 Add General Advice to root Folder
1 parent 61e5096 commit c281c25

File tree

1 file changed

+67
-1
lines changed

1 file changed

+67
-1
lines changed

root/README.md

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The **root** defines several *main sections*. These main sections allow for an e
88

99

1010

11-
## Overview:
11+
## Overview
1212

1313
| Folder | Contents |
1414
| ----------- | ------------------------------------------------------------ |
@@ -21,3 +21,69 @@ The **root** defines several *main sections*. These main sections allow for an e
2121
| video | Movies, Short Movies/Films, TV-Shows, ... |
2222
| web | raw internet content of any kind sorted by domain |
2323

24+
25+
26+
## General Advice
27+
28+
In this Section we want to give you some general advice on things you should be aware of.
29+
30+
These are optional and sometimes biased. If you do not agree to them - be it partially or completely - just ignore this part.
31+
32+
33+
34+
### Naming Files and Folders
35+
36+
1. Naming in General
37+
38+
Naming is hard. We know that. You want everything neat and tidy, but sometimes things just don't go that way - and that is perfectly fine. **Don't be afraid to break the rules and adjust this tree to your needs.**
39+
40+
41+
42+
2. Technical Issues
43+
44+
Some systems simply do not allow certain characters, some others do not play nice with them.
45+
46+
Here is a small (and incomplete) list of characters you should avoid (AKA "Forbidden Characters")
47+
48+
- *Please use this list as a general rule of thumb.*
49+
- *The List applies to all major operating systems.*
50+
51+
52+
53+
```
54+
File Seperators:
55+
: (colon)
56+
/ (forward slash)
57+
\ (backward slash aka "backslash")
58+
59+
Non-alphabetical and non-numerical symbols:
60+
¢ (Cent Symbol)
61+
™ (Trademark Symbol)
62+
$ (Dollar-Sign)
63+
® (Registered Trademark Symbol)
64+
65+
Punctuation marks, parentheses, quotation marks, brackets and operators:
66+
< (less than)
67+
> (greater than)
68+
" (double quote)
69+
' (single quote)
70+
| (vertical bar or pipe)
71+
? (question mark)
72+
* (asterisk)
73+
74+
Other, rather technical "characters":
75+
MultiSpace ("Foo. Bar .txt")
76+
Tab
77+
Newline
78+
NUL (integer value zero)
79+
Embedded Returns
80+
```
81+
82+
83+
84+
References:
85+
86+
- https://superuser.com/a/1112140
87+
- https://support.apple.com/en-us/HT202808
88+
- https://stackoverflow.com/a/31976060
89+

0 commit comments

Comments
 (0)