15073d4f3c
- Present the project and how the configuration files are used - Naming convention: the file naming convention impacts configuration file a lot. Explain it in details. Also serve as documentation for now because wi don't have a Wiki, which would be a better place to document this
16 lines
1.1 KiB
Markdown
16 lines
1.1 KiB
Markdown
# Irrlicht's dotfiles
|
|
|
|
All the dotfiles I use on all my workstations (not my servers). I use the XDG config directory with symbolic links. Symbolic links are also used to separated machine specific configurations which are then symbolically linked for proper inclusion in configuration files (e.g. i3, polybar…).
|
|
|
|
## Naming convention
|
|
|
|
I use a consistent and rigorous file and directory naming convention:
|
|
|
|
- Use only _ASCII characters_
|
|
- Use only _lowercase_
|
|
- All words are _singular_. Keeps every name consistent with no doubt about 's' at the end of a word
|
|
- '_' is used as a separator replacing space, coma, colon, question mark… Never doubled
|
|
- '-' separates categories of information. Never doubled. For example for a song name_of_the_artist-name_of_the_song.
|
|
- Dates are written YYYYMMDD and time HHMMSS. This make parsing easier and keep '-' semantically consistent
|
|
|
|
This convention aims at avoiding ambiguity for writing, understanding the name of a file and manipulating file name in scripts. Splitting on '-' gets all the fields of information of a file. Most files are dated and dates and time is placed at the beginning of a file.
|