Skip to content

Commit b5cab96

Browse files
committed
Finalize the basic content of the README file.
1 parent 7616d12 commit b5cab96

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Beautify Git in Your MacOS or OSX Terminal
22

3-
This set of config files can help transform your command line from something ugly and painful to something delightful and easy-to-read.
3+
This set of config files will transform your command line from ugly and painful to delightful and easy-to-read.
44

55
![](screenshot.png)
66

77
## Setup
88
First things first, you'll want to install a nice color theme for your terminal. The one in the screenshot above is called TupeloHoney, and you'll find it included in the repo. I based it off of the most excellent [Flat](https://github.com/ahmetsulek/flat-terminal) theme.
99

10-
Load the theme by opening up your mac terminal and navigating to **Preferences > Profiles > Import**. Don't expect things to suddenly look like they do above—*we still have work to do*.
10+
Load the theme by opening up your mac terminal and navigating to **Preferences > Profiles > Import**, and then set the theme as your default.
1111

12-
With that out of the way, log into your bash terminal and punch in the following git config commands. You should be able to copy & paste them as a full block and then just hit return. This tells git that we want color in our UI, and sets specific colors for specific file status types.
12+
Now log into your bash terminal and punch in the following git config commands. You should be able to copy & paste them as a full block and just hit return. This tells git that we want color in our UI, and sets specific colors for specific file status types.
1313

1414
**MacOS & OS X:**
1515

@@ -22,18 +22,18 @@ git config --global color.status.updated "green normal"
2222
git config --global color.status.branch "yellow normal bold"
2323
git config --global color.status.header "white normal bold"
2424
```
25-
The final step is to update your .bash_profile with the contents of the bash_profile file included in the repo. The easiest way to do this will be to first show all hidden files on your system, so that you can find that invisible .bash_profile file. You can do this by pasting the following command into your terminal.
25+
Now you'll need to update your .bash_profile with the contents of the bash_profile file included in the repo. The easiest way to do this will be to first *show all hidden files* on your system, because .bash_profile is usually set to invisible. You can show hidden files by pasting the following command into your terminal.
2626

2727
```sh
2828
defaults write com.apple.finder AppleShowAllFiles YES; killall Finder /System/Library/CoreServices/Finder.app
2929
```
30-
Once your finder reloads, you should be able to see all hidden files (files with names that start with a '.') Now navigate to **Users/YourUserNameHere**, and you should see .bash_profile in the directory. If you don't, you simply have to create one (you can do this by just placing an empty text file there and naming it .bash_profile.)
30+
Once your finder reloads, you should be able to see all hidden files. In the finder, navigate to **Users/YourUserNameHere**, and you should see .bash_profile listed in the directory. If you don't, you simply have to create one yourself (just place an empty text file there and name it .bash_profile.)
3131

32-
Either way, open your .bash_profile and paste in the contents of the bash_profile file included in this repo (paste it beneath any other content that's already in there.) Now save the file.
32+
Either way, open your .bash_profile and paste in the contents of the bash_profile included in this repo (paste it beneath any other content that's already in there.) Now save the file.
3333

3434
**Congratulations!** Your .bash_profile now includes all the code that your terminal needs to display it's UI in color, including a nicely colorized bash -ls command, a customized command prompt, and aliases for a number of highly-readable git log formats. You can customize these to your heart's content, but hopefully this will give you a solid jumping-off point.
3535

36-
Now let's hide those invisible files again, by pasting the following command into the terminal.
36+
Now let's hide those invisible files again, by pasting the following command into the terminal and hitting return.
3737

3838
```sh
3939
defaults write com.apple.finder AppleShowAllFiles NO; killall Finder /System/Library/CoreServices/Finder.app
@@ -42,7 +42,7 @@ Restart the terminal app, and you're ready to go!
4242

4343
## Usage
4444

45-
With any luck, you should now have a nice looking command line terminal running on your Mac. Navigate to one of your git repositories as you nomrally would and take a few of the included git log aliases for a ride.
45+
With any luck, you should now have a nice looking command line terminal running on your Mac. If you like, point the terminal to one of your git repositories and take a few of the included git log aliases for a ride.
4646

4747
```sh
4848
log
@@ -56,6 +56,10 @@ Now explore the other log aliases if you like:
5656
- 'loggv' displays an ascii graph of your branches, along with more verbose log info.
5757
- 'logm' displays multi-line commit messages.
5858

59+
Lastly, type in the trusty '-ls' bash command and you should see a nicely colorized list of files, directories, etc.
60+
61+
Well, that's it. You're good to go!
62+
5963
## Release History
6064

6165
* 0.0.1

0 commit comments

Comments
 (0)