From 26a07b0ad87162805e69ce18c56627772a663aef Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Sun, 12 Apr 2015 00:37:35 +0200 Subject: Rename README.markdown to README.md for consistency --- README.markdown | 213 -------------------------------------------------------- README.md | 213 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 213 insertions(+), 213 deletions(-) delete mode 100644 README.markdown create mode 100644 README.md diff --git a/README.markdown b/README.markdown deleted file mode 100644 index 0cbea72c9..000000000 --- a/README.markdown +++ /dev/null @@ -1,213 +0,0 @@ -

- Oh My Zsh -

- -Oh My Zsh is an open source, community-driven framework for managing your [zsh](http://www.zsh.org/) configuration. That sounds boring. Let's try this again. - -__Oh My Zsh is a way of life!__ Once installed, your terminal prompt will become the talk of the town _or your money back!_ Each time you interact with your command prompt, you'll be able to take advantage of the hundreds of bundled plugins and pretty themes. Strangers will come up to you in cafés and ask you, _"that is amazing. are you some sort of genius?"_ Finally, you'll begin to get the sort of attention that you always felt that you deserved. ...or maybe you'll just use the time that you saved to start flossing more often. - -To learn more, visit [ohmyz.sh](http://ohmyz.sh) and follow [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter. - -## Getting Started - -### Prerequisites - -__Disclaimer:__ _Oh My Zsh works best on OS X and Linux._ - -* Unix-based operating system (OS X or Linux) -* [Zsh](http://www.zsh.org) should be installed (v4.3.9 or more recent). If not pre-installed (`zsh --version` to confirm), check the following instruction here: [Installing ZSH](https://github.com/robbyrussell/oh-my-zsh/wiki/Installing-ZSH) -* `curl` or `wget` should be installed -* `git` should be installed - -### Basic Installation - -Oh My Zsh is installed by running one of the following commands in your terminal. You can install this via the command-line with either `curl` or `wget`. - -#### via curl - -```shell -sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)" -``` - -#### via wget - -```shell -sh -c "$(wget https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O -)" -``` - -## Using Oh My Zsh - -### Plugins - -Oh My Zsh comes with a shit load of plugins to take advantage of. You can take a look in the [plugins](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins) directory and/or the [wiki](https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins) to see what's currently available. - -#### Enabling Plugins - -If you spot a plugin (or several) that you would like to use with Oh My Zsh, you will need to edit the `~/.zshrc` file. Once you open it with your favorite editor, you'll see a spot to list all the plugins that you'd like Oh My Zsh to load in initialization. - -For example, this line might begin to look like... - -```shell -plugins=(git bundler osx rake ruby) -``` - -#### Using Plugins - -Most plugins (should! we're working on this) include a __README__, which documents how to use them. - -### Themes - -We'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over one hundred themes now bundled. Most of them have [screenshots](https://wiki.github.com/robbyrussell/oh-my-zsh/themes) on the wiki. Check them out! - -#### Selecting a Theme - -_Robby's theme is the default one. It's not the fanciest one. It's not the simplest one. It's just right (for him)._ - -Once you find a theme that you want to use, you will need to edit the `~/.zshrc` file. You'll see an environment variable (all caps) in there that looks like: - -```shell -ZSH_THEME="robbyrussell" -``` - -To use a different theme, simply change the value to match the name of your desired theme. For example: - -```shell -ZSH_THEME="agnoster" # (this is one of the fancy ones) -``` - -Open up a new terminal window and your prompt should look something like... - -![Agnoster theme](https://cloud.githubusercontent.com/assets/2618447/6316862/70f58fb6-ba03-11e4-82c9-c083bf9a6574.png) - -In case you did not find a suitable theme for your needs, please have a look at the wiki for [more of them](https://github.com/robbyrussell/oh-my-zsh/wiki/External-themes). - -If you're feeling feisty, you can let the computer select one randomly for you each time you open a new terminal window. - - -```shell -ZSH_THEME="random" # (...please let it be pie... please be some pie..) -``` - - -## Advanced Topics - -If you're the type that likes to get their hands dirty, these sections might resonate. - -### Advanced Installation - -Some users may want to change the default path, or manually install Oh My Zsh. - -#### Custom Directory - -The default location is `~/.oh-my-zsh` (hidden in your home directory) - -If you'd like to change the install directory with the `ZSH` environment variable, either by running `export ZSH=/your/path` before installing, or by setting it before the end of the install pipeline like this: - -```shell -export ZSH="$HOME/.dotfiles/oh-my-zsh"; sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)" -``` - -#### Manual Installation - -##### 1. Clone the repository: - -```shell -git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh -``` - -##### 2. *Optionally*, backup your existing `~/.zshrc` file: - -```shell -cp ~/.zshrc ~/.zshrc.orig -``` - -##### 3. Create a new zsh configuration file - -You can create a new zsh config file by copying the template that we included for you. - -```shell -cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc -``` - -##### 4. Change your default shell - -```shell -chsh -s /bin/zsh -``` - -##### 5. Initialize your new zsh configuration - -Once you open up a new terminal window, it should load zsh with Oh My Zsh's configuration. - -### Installation Problems - -If you have any hiccups installing, here are a few common fixes. - -* You _might_ need to modify your `PATH` in `~/.zshrc` if you're not able to find some commands after switching to `oh-my-zsh`. -* If you installed manually or changed the install location, check the `ZSH` environment variable in `~/.zshrc`. - -### Custom Plugins and Themes - -If you want to override any of the default behaviors, just add a new file (ending in `.zsh`) in the `custom/` directory. - -If you have many functions that go well together, you can put them as a `XYZ.plugin.zsh` file in the `custom/plugins/` directory and then enable this plugin. - -If you would like to override the functionality of a plugin distributed with Oh My Zsh, create a plugin of the same name in the `custom/plugins/` directory and it will be loaded instead of the one in `plugins/`. - -## Getting Updates - -By default, you will be prompted to check for upgrades every few weeks. If you would like `oh-my-zsh` to automatically upgrade itself without prompting you, set the following in your `~/.zshrc`: - -```shell -DISABLE_UPDATE_PROMPT=true -``` - -To disable automatic upgrades, set the following in your `~/.zshrc`: - -```shell -DISABLE_AUTO_UPDATE=true -``` - -### Manual Updates - -If you'd like to upgrade at any point in time (maybe someone just released a new plugin and you don't want to wait a week?) you just need to run: - -```shell -upgrade_oh_my_zsh -``` - -Magic! - -## Uninstalling Oh My Zsh - -Oh My Zsh isn't for everyone. We'll miss you, but we want to make this an easy breakup. - -If you want to uninstall `oh-my-zsh`, just run `uninstall_oh_my_zsh` from the command-line. It will remove itself and revert your previous `bash` or `zsh` configuration. - -## Contributing - -I'm far from being a [Zsh](http://www.zsh.org/) expert and suspect there are many ways to improve – if you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests! - -We also need people to test out pull-requests. So take a look through [the open issues](https://github.com/robbyrussell/oh-my-zsh/issues) and help where you can. - -### Do NOT send us themes - -We have (more than) enough themes for the time being. Please add your theme to the [external themes](https://github.com/robbyrussell/oh-my-zsh/wiki/External-themes) wiki page. - -## Contributors - -Oh My Zsh has a vibrant community of happy users and delightful contributors. Without all the time and help from our contributors, it wouldn't be so awesome. - -Thank you so much! - -## Follow Us - -We have an [@ohmyzsh](https://twitter.com/ohmyzsh) Twitter account. You should follow it. - -## Merchandise - -We have [stickers](http://shop.planetargon.com/products/ohmyzsh-stickers-set-of-3-stickers) and [shirts](http://shop.planetargon.com/products/ohmyzsh-t-shirts) for you to show off your love of Oh My Zsh. Again, this will help you become the talk of the town! - -## License - -Oh My Zsh is released under the [MIT license](MIT-LICENSE.txt). diff --git a/README.md b/README.md new file mode 100644 index 000000000..0cbea72c9 --- /dev/null +++ b/README.md @@ -0,0 +1,213 @@ +

+ Oh My Zsh +

+ +Oh My Zsh is an open source, community-driven framework for managing your [zsh](http://www.zsh.org/) configuration. That sounds boring. Let's try this again. + +__Oh My Zsh is a way of life!__ Once installed, your terminal prompt will become the talk of the town _or your money back!_ Each time you interact with your command prompt, you'll be able to take advantage of the hundreds of bundled plugins and pretty themes. Strangers will come up to you in cafés and ask you, _"that is amazing. are you some sort of genius?"_ Finally, you'll begin to get the sort of attention that you always felt that you deserved. ...or maybe you'll just use the time that you saved to start flossing more often. + +To learn more, visit [ohmyz.sh](http://ohmyz.sh) and follow [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter. + +## Getting Started + +### Prerequisites + +__Disclaimer:__ _Oh My Zsh works best on OS X and Linux._ + +* Unix-based operating system (OS X or Linux) +* [Zsh](http://www.zsh.org) should be installed (v4.3.9 or more recent). If not pre-installed (`zsh --version` to confirm), check the following instruction here: [Installing ZSH](https://github.com/robbyrussell/oh-my-zsh/wiki/Installing-ZSH) +* `curl` or `wget` should be installed +* `git` should be installed + +### Basic Installation + +Oh My Zsh is installed by running one of the following commands in your terminal. You can install this via the command-line with either `curl` or `wget`. + +#### via curl + +```shell +sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)" +``` + +#### via wget + +```shell +sh -c "$(wget https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O -)" +``` + +## Using Oh My Zsh + +### Plugins + +Oh My Zsh comes with a shit load of plugins to take advantage of. You can take a look in the [plugins](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins) directory and/or the [wiki](https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins) to see what's currently available. + +#### Enabling Plugins + +If you spot a plugin (or several) that you would like to use with Oh My Zsh, you will need to edit the `~/.zshrc` file. Once you open it with your favorite editor, you'll see a spot to list all the plugins that you'd like Oh My Zsh to load in initialization. + +For example, this line might begin to look like... + +```shell +plugins=(git bundler osx rake ruby) +``` + +#### Using Plugins + +Most plugins (should! we're working on this) include a __README__, which documents how to use them. + +### Themes + +We'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over one hundred themes now bundled. Most of them have [screenshots](https://wiki.github.com/robbyrussell/oh-my-zsh/themes) on the wiki. Check them out! + +#### Selecting a Theme + +_Robby's theme is the default one. It's not the fanciest one. It's not the simplest one. It's just right (for him)._ + +Once you find a theme that you want to use, you will need to edit the `~/.zshrc` file. You'll see an environment variable (all caps) in there that looks like: + +```shell +ZSH_THEME="robbyrussell" +``` + +To use a different theme, simply change the value to match the name of your desired theme. For example: + +```shell +ZSH_THEME="agnoster" # (this is one of the fancy ones) +``` + +Open up a new terminal window and your prompt should look something like... + +![Agnoster theme](https://cloud.githubusercontent.com/assets/2618447/6316862/70f58fb6-ba03-11e4-82c9-c083bf9a6574.png) + +In case you did not find a suitable theme for your needs, please have a look at the wiki for [more of them](https://github.com/robbyrussell/oh-my-zsh/wiki/External-themes). + +If you're feeling feisty, you can let the computer select one randomly for you each time you open a new terminal window. + + +```shell +ZSH_THEME="random" # (...please let it be pie... please be some pie..) +``` + + +## Advanced Topics + +If you're the type that likes to get their hands dirty, these sections might resonate. + +### Advanced Installation + +Some users may want to change the default path, or manually install Oh My Zsh. + +#### Custom Directory + +The default location is `~/.oh-my-zsh` (hidden in your home directory) + +If you'd like to change the install directory with the `ZSH` environment variable, either by running `export ZSH=/your/path` before installing, or by setting it before the end of the install pipeline like this: + +```shell +export ZSH="$HOME/.dotfiles/oh-my-zsh"; sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)" +``` + +#### Manual Installation + +##### 1. Clone the repository: + +```shell +git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh +``` + +##### 2. *Optionally*, backup your existing `~/.zshrc` file: + +```shell +cp ~/.zshrc ~/.zshrc.orig +``` + +##### 3. Create a new zsh configuration file + +You can create a new zsh config file by copying the template that we included for you. + +```shell +cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc +``` + +##### 4. Change your default shell + +```shell +chsh -s /bin/zsh +``` + +##### 5. Initialize your new zsh configuration + +Once you open up a new terminal window, it should load zsh with Oh My Zsh's configuration. + +### Installation Problems + +If you have any hiccups installing, here are a few common fixes. + +* You _might_ need to modify your `PATH` in `~/.zshrc` if you're not able to find some commands after switching to `oh-my-zsh`. +* If you installed manually or changed the install location, check the `ZSH` environment variable in `~/.zshrc`. + +### Custom Plugins and Themes + +If you want to override any of the default behaviors, just add a new file (ending in `.zsh`) in the `custom/` directory. + +If you have many functions that go well together, you can put them as a `XYZ.plugin.zsh` file in the `custom/plugins/` directory and then enable this plugin. + +If you would like to override the functionality of a plugin distributed with Oh My Zsh, create a plugin of the same name in the `custom/plugins/` directory and it will be loaded instead of the one in `plugins/`. + +## Getting Updates + +By default, you will be prompted to check for upgrades every few weeks. If you would like `oh-my-zsh` to automatically upgrade itself without prompting you, set the following in your `~/.zshrc`: + +```shell +DISABLE_UPDATE_PROMPT=true +``` + +To disable automatic upgrades, set the following in your `~/.zshrc`: + +```shell +DISABLE_AUTO_UPDATE=true +``` + +### Manual Updates + +If you'd like to upgrade at any point in time (maybe someone just released a new plugin and you don't want to wait a week?) you just need to run: + +```shell +upgrade_oh_my_zsh +``` + +Magic! + +## Uninstalling Oh My Zsh + +Oh My Zsh isn't for everyone. We'll miss you, but we want to make this an easy breakup. + +If you want to uninstall `oh-my-zsh`, just run `uninstall_oh_my_zsh` from the command-line. It will remove itself and revert your previous `bash` or `zsh` configuration. + +## Contributing + +I'm far from being a [Zsh](http://www.zsh.org/) expert and suspect there are many ways to improve – if you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests! + +We also need people to test out pull-requests. So take a look through [the open issues](https://github.com/robbyrussell/oh-my-zsh/issues) and help where you can. + +### Do NOT send us themes + +We have (more than) enough themes for the time being. Please add your theme to the [external themes](https://github.com/robbyrussell/oh-my-zsh/wiki/External-themes) wiki page. + +## Contributors + +Oh My Zsh has a vibrant community of happy users and delightful contributors. Without all the time and help from our contributors, it wouldn't be so awesome. + +Thank you so much! + +## Follow Us + +We have an [@ohmyzsh](https://twitter.com/ohmyzsh) Twitter account. You should follow it. + +## Merchandise + +We have [stickers](http://shop.planetargon.com/products/ohmyzsh-stickers-set-of-3-stickers) and [shirts](http://shop.planetargon.com/products/ohmyzsh-t-shirts) for you to show off your love of Oh My Zsh. Again, this will help you become the talk of the town! + +## License + +Oh My Zsh is released under the [MIT license](MIT-LICENSE.txt). -- cgit v1.2.3-70-g09d2 From 2198ff05e3b26532865f91a9ac1bac5fc673c05b Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Thu, 12 May 2016 13:52:13 +0200 Subject: Rename license to LICENSE.txt for consistency --- LICENSE.txt | 22 ++++++++++++++++++++++ MIT-LICENSE.txt | 22 ---------------------- README.md | 2 +- 3 files changed, 23 insertions(+), 23 deletions(-) create mode 100644 LICENSE.txt delete mode 100644 MIT-LICENSE.txt diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 000000000..42f607f5d --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2009-2016 Robby Russell and contributors +See the full list at https://github.com/robbyrussell/oh-my-zsh/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. diff --git a/MIT-LICENSE.txt b/MIT-LICENSE.txt deleted file mode 100644 index 42f607f5d..000000000 --- a/MIT-LICENSE.txt +++ /dev/null @@ -1,22 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2009-2016 Robby Russell and contributors -See the full list at https://github.com/robbyrussell/oh-my-zsh/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. diff --git a/README.md b/README.md index 0cbea72c9..5f152e4df 100644 --- a/README.md +++ b/README.md @@ -210,4 +210,4 @@ We have [stickers](http://shop.planetargon.com/products/ohmyzsh-stickers-set-of- ## License -Oh My Zsh is released under the [MIT license](MIT-LICENSE.txt). +Oh My Zsh is released under the [MIT license](LICENSE.txt). -- cgit v1.2.3-70-g09d2 From 66e7e7d9ca78a5e62664abbb3c5c72e163119afb Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Tue, 15 Dec 2015 11:16:02 +0100 Subject: Use .gitkeep files to keep cache/ and log/ directories Instead of .easter-egg files we now have empty .gitkeep files, like is done as an informal standard. --- .gitignore | 3 +++ cache/.easter-egg | 4 ---- cache/.gitkeep | 0 log/.easter-egg | 4 ---- log/.gitkeep | 0 5 files changed, 3 insertions(+), 8 deletions(-) delete mode 100644 cache/.easter-egg create mode 100644 cache/.gitkeep delete mode 100644 log/.easter-egg create mode 100644 log/.gitkeep diff --git a/.gitignore b/.gitignore index 8fa66f02f..567cd4e4d 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,6 @@ custom *.swp !custom/example.zshcache cache/ +!cache/.gitkeep +log/ +!log/.gitkeep diff --git a/cache/.easter-egg b/cache/.easter-egg deleted file mode 100644 index 4b6164edb..000000000 --- a/cache/.easter-egg +++ /dev/null @@ -1,4 +0,0 @@ -This file is only here so that Git will keep a cache directory as .gitignore is ignoring all the files within it. - -Feel free to add love notes for people here. - diff --git a/cache/.gitkeep b/cache/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/log/.easter-egg b/log/.easter-egg deleted file mode 100644 index 2533149e2..000000000 --- a/log/.easter-egg +++ /dev/null @@ -1,4 +0,0 @@ -This file is only here so that Git will keep a log directory as .gitignore is ignoring all the log files within it. - -feel free to add love notes for people here. - diff --git a/log/.gitkeep b/log/.gitkeep new file mode 100644 index 000000000..e69de29bb -- cgit v1.2.3-70-g09d2 From 54ace41f3ce890f76cc455aac3aea0b10a467411 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Sat, 1 Aug 2015 14:47:36 +0200 Subject: Tidy up gitignore file - `custom/example.zshcache` doesn't exist anymore: it's safe to ignore. - `*.swp` files are ignored for no apparent reason. There's nothing in the codebase that generates them. This was introduced by @lepht in commit f78218f6 on 24 May 2011. - Files `locals.zsh` and `projects.zsh` are no longer supported for putting custom configuration there. This is since commit 8debd09 where files were put in a lib/ folder, but failed to modify the .gitignore file as well. The init script was modified as well, so those files aren't even being sourced: they are safe to be deleted or ported into a custom script. --- .gitignore | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 567cd4e4d..b2022081a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,12 +1,8 @@ -locals.zsh -log/.zsh_history -projects.zsh -custom +# custom files +custom/ !custom/plugins/example !custom/example.zsh -*.swp -!custom/example.zshcache + +# temp files directories cache/ -!cache/.gitkeep log/ -!log/.gitkeep -- cgit v1.2.3-70-g09d2 From 7a0d299e96a8a1707630d59859f048e9ebde9456 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Thu, 12 May 2016 13:59:10 +0200 Subject: Reword and clarify example.zsh custom file --- custom/example.zsh | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/custom/example.zsh b/custom/example.zsh index 28ffcae25..c505a9673 100644 --- a/custom/example.zsh +++ b/custom/example.zsh @@ -1,5 +1,10 @@ -# Add yourself some shortcuts to projects you often work on -# Example: +# You can put files here to add functionality separated per file, which +# will be ignored by git. +# Files on the custom/ directory will be automatically loaded by the init +# script, in alphabetical order. + +# For example: add yourself some shortcuts to projects you often work on. +# +# brainstormr=~/Projects/development/planetargon/brainstormr +# cd $brainstormr # -# brainstormr=/Users/robbyrussell/Projects/development/planetargon/brainstormr -# \ No newline at end of file -- cgit v1.2.3-70-g09d2