irrlicht/dotfiles
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
dotfiles/REAME.md
Freyja Wildes 15073d4f3c [readme] short project presentation and explain file naming convention 
- 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
2025-07-19 01:17:05 +02:00

1.1 KiB
Raw Permalink Blame History

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.