<commit_before>A handful of functions, auto-complete helpers, and stuff to make your shell rock.

!https://github.com/eduardolundgren/dotfiles/raw/master/screenshot.png!

h2. Dependencies

* Git [YOU NEED TO HAVE GIT INSTALLED]
* Homebrew (http://mxcl.github.com/homebrew/)
* Zsh: is a shell designed for interactive use (http://www.zsh.org/)
* oh-my-zsh: A community-driven framework for managing your zsh configuration (https://github.com/robbyrussell/oh-my-zsh)

(The automatic installer described in the next section will try to automatically install *Homebrew*, *oh-my-zsh* and *zsh* dependencies. You have to install git yourself.).

h2. Setup

h3. Automatic installer

You can install this via the command line with `curl`

h4. via `curl` (just run this command and be happy)

@curl -L https://github.com/eduardolundgren/dotfiles/raw/master/install.sh | sh@

h3. Customization (optional)

h4. Adding a custom config file

* Create a file called *config.yourusername* on the root folder of ~/dotfiles/.
* Enable the plugins you want (take a look at https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins to see what's possible)
** example: @plugins=(ant ant-ext brew cloudapp ...)@
** *dotfiles* comes with the following plugins enabled: ant, ant-ext, brew, cloudapp, extract, gem, git, git-ext, git-flow, github, history-substring-search, liferay, macports, mysql, node, npm, osx, python, rake, ruby, textmate, rationalise-dot.
* Theme support: Change the @ZSH_THEME@ environment variable in your *config.yourusername*
** @ZSH_THEME="robbyrussell"@

** Take a look at the "current themes" :https://wiki.github.com/robbyrussell/oh-my-zsh/themes that come bundled with _Oh My Zsh_.

h4. Extending dotfiles plugins

* If you have many functions which go well together you can put them as a foobar.plugin.zsh file in the @/plugins/foobar/foobar.plugin.zsh@ directory and then enable this plugin.
** example: @plugins=(... ruby textmate rationalise-dot foobar)@

h4. Extending dotfiles aliases

* Create a file *aliases.yourusername* inside ~/dotfiles/aliases/ and place your custom aliases in there.
** @alias batman='ls -la'@

h3. Uninstalling

Not implemented yet.

h2. Liferay and AlloyUI

* A Liferay (www.liferay.com) and AlloyUI (www.alloyui.com) plugin is provided out of the box (https://github.com/eduardolundgren/dotfiles/blob/master/plugins/liferay/liferay.plugin.zsh). This plugins contains helpful commands to improve your performance doing common tasks during Liferay development.
** In order to make them work correctly you need to set the following variables in your *config.yourusername*:
*** @export LIFERAY_PORTAL="/liferay/github/liferay-portal";@
*** @export ALLOY_UI="/liferay/github/alloy-ui";@
*** @export LIFERAY_BUNDLE="/liferay/bundles/liferay-portal-trunk";@
*** @export LIFERAY_TOMCAT="$LIFERAY_BUNDLE/tomcat-7.0.22";@

h2. Contributors

This project wouldn't exist without all of our awesome users and contributors.

Thank you so much!<commit_msg>Adding README<commit_after>A handful of functions, auto-complete helpers, and stuff to make your shell rock.

!https://github.com/eduardolundgren/dotfiles/raw/master/screenshot.png!

h2. Dependencies

* Git [YOU NEED TO HAVE GIT INSTALLED]
* Homebrew (http://mxcl.github.com/homebrew/)
* Zsh: is a shell designed for interactive use (http://www.zsh.org/)
* oh-my-zsh: A community-driven framework for managing your zsh configuration (https://github.com/robbyrussell/oh-my-zsh)

(The automatic installer described in the next section will try to automatically install *Homebrew*, *oh-my-zsh* and *zsh* dependencies. You have to install git yourself.).

h2. Setup

h3. Automatic installer

You can install this via the command line with `curl`

h4. via `curl` (just run this command and be happy)

@curl -L https://github.com/eduardolundgren/dotfiles/raw/master/install.sh | sh@

h3. Customization (optional)

h4. Adding a custom config file

* Create a file called *config.yourusername* on the root folder of ~/dotfiles/.
* Enable the plugins you want (take a look at https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins to see what's possible)
** example: @plugins=(ant ant-ext brew cloudapp ...)@
** *dotfiles* comes with the following plugins enabled: ant, ant-ext, brew, cloudapp, extract, gem, git, git-ext, git-flow, github, history-substring-search, liferay, macports, mysql, node, npm, osx, python, rake, ruby, textmate, rationalise-dot.
* Theme support: Change the @ZSH_THEME@ environment variable in your *config.yourusername*
** @ZSH_THEME="robbyrussell"@

** Take a look at the "current themes" :https://wiki.github.com/robbyrussell/oh-my-zsh/themes that come bundled with _Oh My Zsh_.

h4. Extending dotfiles plugins

* If you have many functions which go well together you can put them as a foobar.plugin.zsh file in the @/plugins/foobar/foobar.plugin.zsh@ directory and then enable this plugin.
** example: @plugins=(... ruby textmate rationalise-dot foobar)@

h4. Extending dotfiles aliases

* Create a file *aliases.yourusername* inside ~/dotfiles/aliases/ and place your custom aliases in there.
** @alias batman='ls -la'@

h3. Uninstalling

Not implemented yet.

h2. Liferay and AlloyUI

* Already includes https://github.com/liferay/git-tools (gitpr).
* A Liferay (www.liferay.com) and AlloyUI (www.alloyui.com) plugin is provided out of the box (https://github.com/eduardolundgren/dotfiles/blob/master/plugins/liferay/liferay.plugin.zsh). This plugins contains helpful commands to improve your performance doing common tasks during Liferay development.
** In order to make them work correctly you need to set the following variables in your *config.yourusername*:
*** @export LIFERAY_PORTAL="/liferay/github/liferay-portal";@
*** @export ALLOY_UI="/liferay/github/alloy-ui";@
*** @export LIFERAY_BUNDLE="/liferay/bundles/liferay-portal-trunk";@
*** @export LIFERAY_TOMCAT="$LIFERAY_BUNDLE/tomcat-7.0.22";@

h2. Contributors

This project wouldn't exist without all of our awesome users and contributors.

Thank you so much!
{'fraction_non_alphanumeric': 0.11177347242921014, 'fraction_numerical': 0.004967709885742673, 'mean_word_length': 4.687382297551789, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 13, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4499546', 'n_tokens_mistral': 1940, 'n_tokens_neox': 1927, 'n_words': 660}