From 5b90c96cd136eb13010d9e71e36da4f59caed7e3 Mon Sep 17 00:00:00 2001 From: Eric Nielsen Date: Mon, 17 Dec 2018 14:11:16 -0500 Subject: [PATCH] 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' ``` --- modules/autosuggestions/README.md | 2 +- modules/custom/README.md | 13 +++++++------ modules/debug/README.md | 18 ++++++++++++++++++ modules/debug/Readme.md | 19 ------------------- modules/directory/README.md | 2 +- modules/environment/README.md | 4 ++-- modules/git-info/README.md | 8 ++++---- modules/input/README.md | 2 +- modules/pacman/README.md | 2 +- modules/prompt/README.md | 2 +- modules/ssh/README.md | 2 +- modules/syntax-highlighting/README.md | 2 +- modules/utility/README.md | 4 ++-- 13 files changed, 40 insertions(+), 40 deletions(-) create mode 100644 modules/debug/README.md delete mode 100644 modules/debug/Readme.md diff --git a/modules/autosuggestions/README.md b/modules/autosuggestions/README.md index cdffeb8..02cbc31 100644 --- a/modules/autosuggestions/README.md +++ b/modules/autosuggestions/README.md @@ -1,7 +1,7 @@ zsh-autosuggestions =================== -_[Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for zsh._ +_[Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for Zsh._ It suggests commands as you type, based on command history. diff --git a/modules/custom/README.md b/modules/custom/README.md index 36fd8bf..5ba0d61 100644 --- a/modules/custom/README.md +++ b/modules/custom/README.md @@ -1,18 +1,19 @@ -Custom +custom ====== Add any custom aliases/settings to the `init.zsh` file. -Any functions should go in the `functions` folder, where the name of the file is the name of the function. +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: -``` +For example, this function from your `.zshrc`: +```zsh foo() { print 'bar' } ``` -becomes a file named 'foo' in the functions folder containing: -``` +becomes a file named `foo` in the `functions` subdirectory containing: +```zsh print 'bar' ``` diff --git a/modules/debug/README.md b/modules/debug/README.md new file mode 100644 index 0000000..8f7c152 --- /dev/null +++ b/modules/debug/README.md @@ -0,0 +1,18 @@ +debug +===== + +Provides a function to debug Zim. + +Functions +--------- + + * `trace-zim` provides a trace of Zsh/Zim startup + +Notes +----- + +`trace-zim` will not alter your current dotfiles. It will copy your environment +to a temporary directory, launch Zsh within that environment, and output logs. + +This will provide a `ztrace.tar.gz` archive, which should be attached to any bug +reports if you need help with an issue that you don't understand. diff --git a/modules/debug/Readme.md b/modules/debug/Readme.md deleted file mode 100644 index 0ec55a3..0000000 --- a/modules/debug/Readme.md +++ /dev/null @@ -1,19 +0,0 @@ -Debug -===== - -Provides a function to debug Zim. - -Functions ---------- - - - `trace-zim` provides a trace of Zsh/Zim startup - -Notes ------ - -The `trace-zim` command will not alter your current dotfiles. -It will copy your environment to a temporary directory, launch zsh -within that environment, and output logs. - -This will provide a ztrace.tar.gz archive, which should be attached -to any bug reports if you need help with an issue that you don't understand. diff --git a/modules/directory/README.md b/modules/directory/README.md index 93118a6..93f9d0a 100644 --- a/modules/directory/README.md +++ b/modules/directory/README.md @@ -3,7 +3,7 @@ directory Sets directory, navigation, and redirect options. -zsh options +Zsh options ----------- * `AUTO_CD` performs cd to a directory if the typed command is invalid, but is a directory. diff --git a/modules/environment/README.md b/modules/environment/README.md index dd51a5d..7a1cb02 100644 --- a/modules/environment/README.md +++ b/modules/environment/README.md @@ -1,13 +1,13 @@ environment =========== -Sets generic zsh built-in environment options. +Sets generic Zsh built-in environment options. Also enables smart URL-pasting. This prevents the user from having to manually escape URLs. Uses `.zimrc` defined `${ztermtitle}` variable to set the terminal title, if defined. -zsh options +Zsh options ----------- * `AUTO_RESUME` resumes an existing job before creating a new one. diff --git a/modules/git-info/README.md b/modules/git-info/README.md index cd82127..6f693cb 100644 --- a/modules/git-info/README.md +++ b/modules/git-info/README.md @@ -12,7 +12,7 @@ Git **1.7.2** is the Settings -------- -### Ignore Submodules +### Ignore submodules Retrieving the status of a repository with submodules can take a long time. So by default 'all' submodules are ignored. Optionally, 'untracked', 'dirty', or @@ -20,7 +20,7 @@ So by default 'all' submodules are ignored. Optionally, 'untracked', 'dirty', or zstyle ':zim:git-info' ignore-submodules 'none' -### Verbose Mode +### Verbose mode Verbose mode uses `git status` and computes the count of indexed, unindexed and also untracked files. It can be enabled with the following zstyle: @@ -41,7 +41,7 @@ a style is: zstyle ':zim:git-info:context' format 'string' -### Main Contexts +### Main contexts | Name | Code | Description | --------- | :----: | -------------------------------------------------------- @@ -65,7 +65,7 @@ state](http://gitfaq.org/articles/what-is-a-detached-head.html), on the other hand, `ahead`, `behind`, `diverged`, `branch` and `remote` are only available when an actual branch is checked out (so when **not** in 'detached HEAD' state). -### Special Action Contexts +### Special action contexts | Name | Format | Default Value | --------------------------- | :-----: | ------------------------------------- diff --git a/modules/input/README.md b/modules/input/README.md index 6b49f9a..a05ff46 100644 --- a/modules/input/README.md +++ b/modules/input/README.md @@ -3,7 +3,7 @@ input Applies correct bindkeys for input events. -Without this module, you may experience oddities in how zsh interprets input. +Without this module, you may experience oddities in how Zsh interprets input. For example, pressing LEFT and then the DELETE key may capitalize characters rather than delete them. diff --git a/modules/pacman/README.md b/modules/pacman/README.md index 0cf9ea1..588854c 100644 --- a/modules/pacman/README.md +++ b/modules/pacman/README.md @@ -1,4 +1,4 @@ -Pacman +pacman ====== Adds aliases for the pacman package manager. diff --git a/modules/prompt/README.md b/modules/prompt/README.md index edd0018..0f0270c 100644 --- a/modules/prompt/README.md +++ b/modules/prompt/README.md @@ -1,4 +1,4 @@ -Prompt +prompt ====== Initializes and provides customizable prompt themes. diff --git a/modules/ssh/README.md b/modules/ssh/README.md index ea176c1..30195bc 100644 --- a/modules/ssh/README.md +++ b/modules/ssh/README.md @@ -1,4 +1,4 @@ -SSH +ssh === Provides a convenient way to load ssh-agent. This enables one-time login and caching of SSH credentials per session. diff --git a/modules/syntax-highlighting/README.md b/modules/syntax-highlighting/README.md index a623def..d9ae4df 100644 --- a/modules/syntax-highlighting/README.md +++ b/modules/syntax-highlighting/README.md @@ -1,4 +1,4 @@ -Syntax-Highlighting +syntax-highlighting =================== Adds fish shell-like [syntax highlighting](https://github.com/zsh-users/zsh-syntax-highlighting) to your shell. diff --git a/modules/utility/README.md b/modules/utility/README.md index 14ef646..8a8cfde 100644 --- a/modules/utility/README.md +++ b/modules/utility/README.md @@ -20,11 +20,11 @@ Aliases * `lt` lists sorted by newest modification time last. * `lc` lists sorted by newest status change (ctime) last. -### File Downloads +### File downloads * `get` is short for ( `aria2c` || `axel` || `wget` || `curl` ). -### Resource Usage +### Resource usage * `df` reports file system disk usage with human-readable sizes. * `du` reports file disk usage with human-readable sizes.