README.md in zsh_dots-0.5.4 vs README.md in zsh_dots-0.5.5

- old
+ new

@@ -1,29 +1,44 @@ DOTS ==== -DOTS is a framework for ZSH that helps you manage your dot-files, ZSH sugar functionality, and your general shell experience. It began its life as a fork off the popular [Oh My ZSH framework][omz]. It has similar design philosophies and functionality, but different goals. Where Oh My ZSH is meant for new users to get more acclamated with ZSH, DOTS is meant for the slightly more advanced user who wants the built-in functionality of Oh My ZSH but wants additional customization and functionality, such as the copying and synchronization of "dot-files". +DOTS is a framework for ZSH that helps you manage your dot-files, ZSH +sugar functionality, and your general shell experience. It began its +life as a fork off the popular [Oh My ZSH framework][omz]. It has +similar design philosophies and functionality, but different goals. +Where Oh My ZSH is meant for new users to get more acclamated with ZSH, +DOTS is meant for the slightly more advanced user who wants the built-in +functionality of Oh My ZSH but wants a bit more additional +customization. It also includes some extra tools that help with day-to-day +shell management tasks. Features -------- - Modular plugin architecture inspired by [Oh My ZSH][omz], but using Antigen for greater efficiency. Only code that's specific to your repo needs to be in your repo. - Simplified prompt string themeing in the `lib/dots/prompt.zsh` directory. -- Configuration persistence via the `persist` command. This copies your dot-files to the **config/** - directory and allows you to optionally store them in Git. Add your persisted configs to your fork's - `.gitignore` if you don't want them synchronized, and `forget` them when you don't want them symlinked - anymore. Keeping your configuration files in a place that's easily accessible with a text editor helps you - keep an eye on your configuration. +- Configuration persistence via the `persist` command. This copies your + dot-files to the **config/** directory and allows you to optionally + store them in Git. Add your persisted configs to your fork's + `.gitignore` if you don't want them synchronized, and `forget` + them when you don't want them symlinked anymore. Keeping your + configuration files in a place that's easily accessible with a + text editor helps you keep an eye on your configuration. - Aliases for common shell functionality like searching for a running process, opening your text editor, viewing files with a pager, setting the title of the current iTerm tab, [optimizing your OS X environment](osx4h), and much more. +- Environment boostrapping, installs a global gemset and a series of + programs through Homebrew (as well as Homebrew itself) that aid in + your day-to-day programming tasks. Installation ------------ +Unlike Oh My ZSH, DOTS is installed as a gem. + Just run the following commands: ```bash $ gem install zsh_dots $ dots install @@ -79,10 +94,17 @@ conventions are prime examples of how DOTS is constructed. They all use sensible defaults, for example `o` will open the current directory, but `o ~/Code` will open up ~/Code in the Finder. `e` follows suit, but `v` throws an error as this should almost never be the case. +### dots + +The DOTS binary is another useful tool in your shell adventures. Invoke +`dots help` to check out what it does. This binary is most useful for +updating the DOTS framework from source and bootstrapping the environment +on new installs. + Hidden Configuration -------------------- In many cases, programmers want to keep some sensible defaults checked in to their DOTS repo, but may need to keep their own personal key and @@ -91,57 +113,89 @@ Git and by DOTS when it symlinks configuration into the repo. In your application's dotfile, insert the following line to load configuration from your untracked file: ```bash -. $DOTS/config/file.zsh +hidden_config_for 'file' ``` -Forking -------- +This will run the following shell command: -It's recommended that you fork this project so you can store your own custom settings in **config/**, and get the most use out of this framework. +```bash +$ source $DOTS/config/$1.zsh +``` -To do so, click the **Fork** button at the top of this page. +where `$1` is the first argument given to the function. -Then, type the following into your Terminal: +Environment Bootstrapping +------------------------- - git remote add <your-github-username> git@github.com:<your-github-username>/dots.git +DOTS installs a number of programs for you: -And to make sure it works, type +- **HTTPie** for querying HTTP, and displaying the results in a colorful + format. +- **Vim** for text editing. It fits into the DOTS philosophy very nicely + of having each program do one thing really well. +- The latest version of the **Ruby** programming language. We believe + that you should keep your tools up to date, and Homebrew has been + very reliable in maintaining the latest version of Ruby, as Homebrew + is itself a Ruby project. It's also a great shell scripting language, + among other things... +- **Ruby on Rails**. I'm a Rails developer, so having Rails in the + global Gemfile is a must. If this offends you, you may kindly remove + the gem as it isn't really necessary for your use. However, this + framework is bundled with a number of aliases/plugins for use in Rails + projects, so I felt like including Rails makes the whole thing + "complete". +- **AWS Developer Tools** for interfacing with Amazon Web Services. I + use AWS to host all of my projects, both at work and at home, and + these tools make it very easy to get statistics on your instances + quickly. +- **Git** is my favorite distributed version control system, and I use + it on all of my projects, both private and public. DOTS also installs + a number of plugins for Git that I find useful: **git_tracker** for + automatically including a Pivotal Tracker issue number in commits + when your branch follows a specific naming convention, **git-process** + for managing a strict feature branch-based workflow, and **hub** for + easy interfacing with Github (allowing you to clone with a simple + short Github URL: `git clone tubbo/dots`, make pull requests and edit + them in Vim, define issues, and fork projects). With the exception of + **hub** all of these gems are completely optional, and must be + installed explicitly in each new project (as they add Git hooks). - git pull <your-github-username> master - -We like the follow the convention for fork names set forth in [the hub plugin][hub] by [Chris Wernstrath][cw]. You can feasibly name the fork anything you like. - -You can either modify **tools/upgrade.sh** to `git pull` from your fork and `git push` to your fork after the upgrade is complete to keep it in sync, or do it manually by setting `DISABLE_AUTO_UPDATE="true"` (which is disabled by default in **config/zshrc**). - -Usage ------ - -Edit `lib/dots/prompt.zsh` to change your prompt string. - -Type `persist .vimrc` or `forget .vimrc` to either add or remove your configs to the .dots/ directory, wherein they can then be pushed to your GitHub fork. - License ------- DOTS is released under **The MIT License**: Copyright (c) 2012 Tom Scott - 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: + 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 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. + 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. -Contributors +Contributing ------------ -Just me, [@tubbo][twt] +To contribute to the project, fork it and send me a pull request! +I accept either traditional email pulls or Github pull requests. + [omz]: https://github.com/robbyrussell/oh-my-zsh -[twt]: https://twitter.com/tubbo [hub]: https://github.com/defunkt/hub [cw]: https://defunkt.io [osx4h]: https://gist.github.com/2260182