From cc2f163ad1919c05058b85c0ec2ea6f67bfb1976 Mon Sep 17 00:00:00 2001 From: Sorin Ionescu Date: Tue, 11 Sep 2012 10:46:13 -0400 Subject: [PATCH] Move README files to documentation/markdown --- .../markdown/prezto-archive.md | 0 .../markdown/prezto-command-not-found.md | 0 .../markdown/prezto-completion.md | 0 .../markdown/prezto-directory.md | 0 .../markdown/prezto-dpkg.md | 0 .../markdown/prezto-editor.md | 0 .../markdown/prezto-emacs.md | 0 .../markdown/prezto-environment.md | 0 .../markdown/prezto-fasd.md | 0 .../markdown/prezto-git.md | 0 .../markdown/prezto-gnu-utility.md | 0 .../markdown/prezto-gpg.md | 0 .../markdown/prezto-haskell.md | 0 .../markdown/prezto-helper.md | 0 .../prezto-history-substring-search.md | 0 .../markdown/prezto-history.md | 0 .../markdown/prezto-homebrew.md | 0 .../markdown/prezto-macports.md | 0 .../markdown/prezto-modules.md | 0 .../markdown/prezto-node.md | 0 .../markdown/prezto-osx.md | 0 .../markdown/prezto-pacman.md | 0 .../markdown/prezto-perl.md | 0 .../markdown/prezto-prompt.md | 0 .../markdown/prezto-python.md | 0 .../markdown/prezto-rails.md | 0 .../markdown/prezto-rsync.md | 0 .../markdown/prezto-ruby.md | 0 .../markdown/prezto-runcoms.md | 0 .../markdown/prezto-screen.md | 0 .../markdown/prezto-spectrum.md | 0 .../markdown/prezto-ssh.md | 0 .../markdown/prezto-syntax-highlighting.md | 0 .../markdown/prezto-terminal.md | 0 .../markdown/prezto-tmux.md | 0 .../markdown/prezto-utility.md | 0 .../markdown/prezto-wakeonlan.md | 0 .../markdown/prezto-yum.md | 0 documentation/markdown/prezto.md | 109 ++++++++++++++++++ 39 files changed, 109 insertions(+) rename modules/archive/README.md => documentation/markdown/prezto-archive.md (100%) rename modules/command-not-found/README.md => documentation/markdown/prezto-command-not-found.md (100%) rename modules/completion/README.md => documentation/markdown/prezto-completion.md (100%) rename modules/directory/README.md => documentation/markdown/prezto-directory.md (100%) rename modules/dpkg/README.md => documentation/markdown/prezto-dpkg.md (100%) rename modules/editor/README.md => documentation/markdown/prezto-editor.md (100%) rename modules/emacs/README.md => documentation/markdown/prezto-emacs.md (100%) rename modules/environment/README.md => documentation/markdown/prezto-environment.md (100%) rename modules/fasd/README.md => documentation/markdown/prezto-fasd.md (100%) rename modules/git/README.md => documentation/markdown/prezto-git.md (100%) rename modules/gnu-utility/README.md => documentation/markdown/prezto-gnu-utility.md (100%) rename modules/gpg/README.md => documentation/markdown/prezto-gpg.md (100%) rename modules/haskell/README.md => documentation/markdown/prezto-haskell.md (100%) rename modules/helper/README.md => documentation/markdown/prezto-helper.md (100%) rename modules/history-substring-search/README.md => documentation/markdown/prezto-history-substring-search.md (100%) rename modules/history/README.md => documentation/markdown/prezto-history.md (100%) rename modules/homebrew/README.md => documentation/markdown/prezto-homebrew.md (100%) rename modules/macports/README.md => documentation/markdown/prezto-macports.md (100%) rename modules/README.md => documentation/markdown/prezto-modules.md (100%) rename modules/node/README.md => documentation/markdown/prezto-node.md (100%) rename modules/osx/README.md => documentation/markdown/prezto-osx.md (100%) rename modules/pacman/README.md => documentation/markdown/prezto-pacman.md (100%) rename modules/perl/README.md => documentation/markdown/prezto-perl.md (100%) rename modules/prompt/README.md => documentation/markdown/prezto-prompt.md (100%) rename modules/python/README.md => documentation/markdown/prezto-python.md (100%) rename modules/rails/README.md => documentation/markdown/prezto-rails.md (100%) rename modules/rsync/README.md => documentation/markdown/prezto-rsync.md (100%) rename modules/ruby/README.md => documentation/markdown/prezto-ruby.md (100%) rename runcoms/README.md => documentation/markdown/prezto-runcoms.md (100%) rename modules/screen/README.md => documentation/markdown/prezto-screen.md (100%) rename modules/spectrum/README.md => documentation/markdown/prezto-spectrum.md (100%) rename modules/ssh/README.md => documentation/markdown/prezto-ssh.md (100%) rename modules/syntax-highlighting/README.md => documentation/markdown/prezto-syntax-highlighting.md (100%) rename modules/terminal/README.md => documentation/markdown/prezto-terminal.md (100%) rename modules/tmux/README.md => documentation/markdown/prezto-tmux.md (100%) rename modules/utility/README.md => documentation/markdown/prezto-utility.md (100%) rename modules/wakeonlan/README.md => documentation/markdown/prezto-wakeonlan.md (100%) rename modules/yum/README.md => documentation/markdown/prezto-yum.md (100%) create mode 100644 documentation/markdown/prezto.md diff --git a/modules/archive/README.md b/documentation/markdown/prezto-archive.md similarity index 100% rename from modules/archive/README.md rename to documentation/markdown/prezto-archive.md diff --git a/modules/command-not-found/README.md b/documentation/markdown/prezto-command-not-found.md similarity index 100% rename from modules/command-not-found/README.md rename to documentation/markdown/prezto-command-not-found.md diff --git a/modules/completion/README.md b/documentation/markdown/prezto-completion.md similarity index 100% rename from modules/completion/README.md rename to documentation/markdown/prezto-completion.md diff --git a/modules/directory/README.md b/documentation/markdown/prezto-directory.md similarity index 100% rename from modules/directory/README.md rename to documentation/markdown/prezto-directory.md diff --git a/modules/dpkg/README.md b/documentation/markdown/prezto-dpkg.md similarity index 100% rename from modules/dpkg/README.md rename to documentation/markdown/prezto-dpkg.md diff --git a/modules/editor/README.md b/documentation/markdown/prezto-editor.md similarity index 100% rename from modules/editor/README.md rename to documentation/markdown/prezto-editor.md diff --git a/modules/emacs/README.md b/documentation/markdown/prezto-emacs.md similarity index 100% rename from modules/emacs/README.md rename to documentation/markdown/prezto-emacs.md diff --git a/modules/environment/README.md b/documentation/markdown/prezto-environment.md similarity index 100% rename from modules/environment/README.md rename to documentation/markdown/prezto-environment.md diff --git a/modules/fasd/README.md b/documentation/markdown/prezto-fasd.md similarity index 100% rename from modules/fasd/README.md rename to documentation/markdown/prezto-fasd.md diff --git a/modules/git/README.md b/documentation/markdown/prezto-git.md similarity index 100% rename from modules/git/README.md rename to documentation/markdown/prezto-git.md diff --git a/modules/gnu-utility/README.md b/documentation/markdown/prezto-gnu-utility.md similarity index 100% rename from modules/gnu-utility/README.md rename to documentation/markdown/prezto-gnu-utility.md diff --git a/modules/gpg/README.md b/documentation/markdown/prezto-gpg.md similarity index 100% rename from modules/gpg/README.md rename to documentation/markdown/prezto-gpg.md diff --git a/modules/haskell/README.md b/documentation/markdown/prezto-haskell.md similarity index 100% rename from modules/haskell/README.md rename to documentation/markdown/prezto-haskell.md diff --git a/modules/helper/README.md b/documentation/markdown/prezto-helper.md similarity index 100% rename from modules/helper/README.md rename to documentation/markdown/prezto-helper.md diff --git a/modules/history-substring-search/README.md b/documentation/markdown/prezto-history-substring-search.md similarity index 100% rename from modules/history-substring-search/README.md rename to documentation/markdown/prezto-history-substring-search.md diff --git a/modules/history/README.md b/documentation/markdown/prezto-history.md similarity index 100% rename from modules/history/README.md rename to documentation/markdown/prezto-history.md diff --git a/modules/homebrew/README.md b/documentation/markdown/prezto-homebrew.md similarity index 100% rename from modules/homebrew/README.md rename to documentation/markdown/prezto-homebrew.md diff --git a/modules/macports/README.md b/documentation/markdown/prezto-macports.md similarity index 100% rename from modules/macports/README.md rename to documentation/markdown/prezto-macports.md diff --git a/modules/README.md b/documentation/markdown/prezto-modules.md similarity index 100% rename from modules/README.md rename to documentation/markdown/prezto-modules.md diff --git a/modules/node/README.md b/documentation/markdown/prezto-node.md similarity index 100% rename from modules/node/README.md rename to documentation/markdown/prezto-node.md diff --git a/modules/osx/README.md b/documentation/markdown/prezto-osx.md similarity index 100% rename from modules/osx/README.md rename to documentation/markdown/prezto-osx.md diff --git a/modules/pacman/README.md b/documentation/markdown/prezto-pacman.md similarity index 100% rename from modules/pacman/README.md rename to documentation/markdown/prezto-pacman.md diff --git a/modules/perl/README.md b/documentation/markdown/prezto-perl.md similarity index 100% rename from modules/perl/README.md rename to documentation/markdown/prezto-perl.md diff --git a/modules/prompt/README.md b/documentation/markdown/prezto-prompt.md similarity index 100% rename from modules/prompt/README.md rename to documentation/markdown/prezto-prompt.md diff --git a/modules/python/README.md b/documentation/markdown/prezto-python.md similarity index 100% rename from modules/python/README.md rename to documentation/markdown/prezto-python.md diff --git a/modules/rails/README.md b/documentation/markdown/prezto-rails.md similarity index 100% rename from modules/rails/README.md rename to documentation/markdown/prezto-rails.md diff --git a/modules/rsync/README.md b/documentation/markdown/prezto-rsync.md similarity index 100% rename from modules/rsync/README.md rename to documentation/markdown/prezto-rsync.md diff --git a/modules/ruby/README.md b/documentation/markdown/prezto-ruby.md similarity index 100% rename from modules/ruby/README.md rename to documentation/markdown/prezto-ruby.md diff --git a/runcoms/README.md b/documentation/markdown/prezto-runcoms.md similarity index 100% rename from runcoms/README.md rename to documentation/markdown/prezto-runcoms.md diff --git a/modules/screen/README.md b/documentation/markdown/prezto-screen.md similarity index 100% rename from modules/screen/README.md rename to documentation/markdown/prezto-screen.md diff --git a/modules/spectrum/README.md b/documentation/markdown/prezto-spectrum.md similarity index 100% rename from modules/spectrum/README.md rename to documentation/markdown/prezto-spectrum.md diff --git a/modules/ssh/README.md b/documentation/markdown/prezto-ssh.md similarity index 100% rename from modules/ssh/README.md rename to documentation/markdown/prezto-ssh.md diff --git a/modules/syntax-highlighting/README.md b/documentation/markdown/prezto-syntax-highlighting.md similarity index 100% rename from modules/syntax-highlighting/README.md rename to documentation/markdown/prezto-syntax-highlighting.md diff --git a/modules/terminal/README.md b/documentation/markdown/prezto-terminal.md similarity index 100% rename from modules/terminal/README.md rename to documentation/markdown/prezto-terminal.md diff --git a/modules/tmux/README.md b/documentation/markdown/prezto-tmux.md similarity index 100% rename from modules/tmux/README.md rename to documentation/markdown/prezto-tmux.md diff --git a/modules/utility/README.md b/documentation/markdown/prezto-utility.md similarity index 100% rename from modules/utility/README.md rename to documentation/markdown/prezto-utility.md diff --git a/modules/wakeonlan/README.md b/documentation/markdown/prezto-wakeonlan.md similarity index 100% rename from modules/wakeonlan/README.md rename to documentation/markdown/prezto-wakeonlan.md diff --git a/modules/yum/README.md b/documentation/markdown/prezto-yum.md similarity index 100% rename from modules/yum/README.md rename to documentation/markdown/prezto-yum.md diff --git a/documentation/markdown/prezto.md b/documentation/markdown/prezto.md new file mode 100644 index 00000000..d076cc89 --- /dev/null +++ b/documentation/markdown/prezto.md @@ -0,0 +1,109 @@ +Prezto — Instantly Awesome Zsh +============================== + +Prezto is the configuration framework for [Zsh][1]; it enriches the command line +interface environment with sane defaults, aliases, functions, auto completion, +and prompt themes. + +Installation +------------ + +Prezto will work with any recent release of Zsh, but the minimum recommended +version is 4.3.10. + + 1. Launch Zsh: + + zsh + + 2. Clone the repository: + + git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto" + + 3. Create a new Zsh configuration by copying the Zsh configuration files + provided: + + setopt EXTENDED_GLOB + for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do + ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}" + done + + 4. Set Zsh as your default shell: + + chsh -s /bin/zsh + + 5. Open a new Zsh terminal window or tab. + +### Troubleshooting + +If you are not able to find certain commands after switching to *Prezto*, +modify the `PATH` variable in *~/.zshenv* then open a new Zsh terminal +window or tab. + +Usage +----- + +Prezto has many features disabled by default. Read the source code and +accompanying README files to learn of what is available. + +### Modules + + 1. Browse */modules* to see what is available. + 2. Load the modules you need in *~/.zpreztorc* then open a new Zsh terminal + window or tab. + +### Themes + + 1. For a list of themes, type `prompt -l`. + 2. To preview a theme, type `prompt -p name`. + 3. Load the theme you like in *~/.zpreztorc* then open a new Zsh terminal + window or tab. + + ![sorin theme][2] + +Customization +------------- + +The project is managed via [Git][3]. It is highly recommended that you fork this +project; so, that you can commit your changes and push them to [GitHub][4] to +not lose them. If you do not know how to use Git, follow this [tutorial][5] and +bookmark this [reference][6]. + +Resources +--------- + +The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable. + +License +------- + +(The MIT License) + +Copyright (c) 2009-2012 Robby Russell, Sorin Ionescu, and contributors. + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +[1]: http://www.zsh.org +[2]: http://i.imgur.com/nBEEZ.png "sorin theme" +[3]: http://git-scm.com +[4]: https://github.com +[5]: http://gitimmersion.com +[6]: http://gitref.org +[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf +[8]: http://grml.org/zsh/zsh-lovers.html +