Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

add superpowers to the readme

  • Loading branch information...
commit 99710de75845f31a71d0779c94a3fcadbadb82f7 1 parent 985e813
@holman authored
Showing with 20 additions and 7 deletions.
  1. +20 −7 README.markdown
View
27 README.markdown
@@ -2,7 +2,7 @@
## dotfiles
-Your dotfiles are how you personalize your system. These are mine. The very prejudiced mix: OS X, zsh, Ruby, Rails, git, homebrew, TextMate. If you match up along most of those lines, you may dig my dotfiles.
+Your dotfiles are how you personalize your system. These are mine. The very prejudiced mix: OS X, zsh, Ruby, Rails, git, homebrew, rvm, TextMate. If you match up along most of those lines, you may dig my dotfiles.
I was a little tired of having long alias files and everything strewn about (which is extremely common on other dotfiles projects, too). That led to this project being much more topic-centric. I realized I could split a lot of things up into the main areas I used (Ruby, git, system libraries, and so on), so I structured the project accordingly.
@@ -10,6 +10,7 @@ I was a little tired of having long alias files and everything strewn about (whi
- [Homebrew](http://github.com/mxcl/homebrew)
- grc (`brew install grc`, for pretty colors)
+- [rvm](http://rvm.beginrescueend.com)
## install
@@ -19,17 +20,29 @@ I was a little tired of having long alias files and everything strewn about (whi
The install rake task will symlink the appropriate files in `.dotfiles` to your home directory. Everything is configured and tweaked within `~/.dotfiles`, though.
-## what's inside
+The main file you'll want to change right off the bat is `zsh/zshrc.symlink`, which sets up a few paths that'll be different on your particular machine.
+
+## show me
+
+<img src="http://cl.ly/1Q39/content" />
-A bunch of stuff. Here's a tiny snapshot of a simple git session:
+This shows a simple session. I keep my prompts pretty simple: the current Ruby I'm running, the current directory I'm in, and the branch and status of git if the directory I'm in is a git repo.
-<img src="http://cl.ly/WNz/content" />
+## topical
+
+Everything's built around topic areas. If you're adding a new area to your forked dotfiles — say, "Java" — you can simply add a `java` directory and put files in there. Anything with an extension of `.zsh` will get automatically included into your shell. Anything with an extension of `.symlink` will get symlinked without extension into `$HOME` when you run `rake install`.
+
+## what's inside
-Notice the simple directory display, the branch set on the right, the color and plus sign depicting the dirty status and the push status of your code, and the touching of Kevin Bacon.
+A lot of what's inside is just aliases: `gs` for `git status`, `gl` for `git pull --rebase --prune`, for example. You can browse the `aliases.zsh` files in each topic directory. There's also a collection of scripts in `bin` you can browse. A few notable ones:
-Beyond that, some Ruby aliases, some git helper scripts, some system helper scripts.
+###rails
+- `s` pings your system for any running Rails apps, and `deathss` will then kill all of them indiscriminately. `ss` starts up a new Rails server on the next available port- if 3000 is taken, it'll spin up your server on 3001.
-If you're adding a new area to your forked repo — say, "Java" — you can simply add a `java` directory and put files in there. Anything with an extension of `.zsh` will get automatically included into your shell profile. Anything with an extension of `.symlink` will get symlinked without extension into `$HOME` when you run `rake install`.
+###system
+- `c` is an autocomplete shortcut to your projects directory. For example, `c git` and then hitting tab will autocomplete to `github`, and then it simply changes to my `github` directory.
+- `check [filename]` is a quick script that tells you whether a domain is available to register.
+- `smartextract [filename]` will extract about a billion different compressed/uncompressed/whatever files.
## thanks
Please sign in to comment.
Something went wrong with that request. Please try again.