f6ddb3d2a256b394e9e8e12af3bc59bde5d18d78
[feisty_meow.git] / scripts / customize / how_to_customize.txt
1
2 customizations are cool
3 =======================
4
5 this folder has some examples of customizations that override the default
6 feisty meow environment.
7
8 user customization folder organization
9 ======================================
10
11 the user's optional custom folder is located at:
12 echo $FEISTY_MEOW_SCRIPTS/customize/$(logname)
13
14 the top-level of the customization folder can store:
15
16 + alias files (ending in .alias) that are written in bash; these are added
17   into the feisty meow environment as additional aliases.
18
19 + sourceable bash scripts (ending in our bash extension of '.sh'); these
20   will be pulled into the main-line of the script initialization process
21   using the bash 'source' command.  these scripts can change or add any
22   environment variables and aliases as needed, so be careful writing them.
23
24 custom script aliases
25 =====================
26
27 there is also a facility for adding aliases automatically for any custom
28 scripts that have been developed by the user.  these join the other aliases
29 provided by the feisty meow environment.
30
31 store any custom scripts in the folder:
32 $FEISTY_MEOW_SCRIPTS/customize/$(logname)/scripts
33
34 any scripts in that folder (or in a directory under that folder) will
35 automatically be turned into aliases.
36
37