1
0
Fork 0
mirror of synced 2024-11-26 17:25:35 -05:00
zimfw/modules/custom
Eric Nielsen 5b90c96cd1 Update modules' README.md
Stick with the following style:

* Header 1 with the module name is in `lowercase`.
* Other headers are in `Sentence case`. Common header names that should
  be consistently used are `Aliases`, `Contributing`, `Functions`,
  `Settings`, and `Zsh options`.
* The names `Zim` and `Zsh` always appear capitalized, even in the
  middle of sentences.
* Prefer

      print 'code indented with 4 spaces'

  instead of
  ```zsh
  print 'code fenced by lines with three back-ticks'
  print 'unless you want syntax highlighting'
  ```
2018-12-17 14:11:16 -05:00
..
functions Allow arbitrary ZIM location with ZIM_HOME 2017-09-04 17:25:01 -05:00
init.zsh re-word custom/init.zsh 2015-12-31 10:48:03 -05:00
README.md Update modules' README.md 2018-12-17 14:11:16 -05:00

custom

Add any custom aliases/settings to the init.zsh file.

Any functions should go in the functions subdirectory, where the name of the file is the name of the function.

For example, this function from your .zshrc:

foo() {
  print 'bar'
}

becomes a file named foo in the functions subdirectory containing:

print 'bar'