Skip to content

Commit 023530d

Browse files
committed
Update README file.
1 parent 86df970 commit 023530d

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

+18-10
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ This set of config files can help transform your command line from something ugl
55
![](screenshot.png)
66

77
## Setup
8-
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 this repo. I based it off of the most excellent [Flat terminal theme](https://github.com/ahmetsulek/flat-terminal) from [ahmetsulek](https://github.com/ahmetsulek).
8+
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-
You can load the theme by opening up your mac terminal and navigating to **Preferences > Profiles > Import**.
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*.
1111

12-
With that out of the way, we can now log into the bash terminal and set our git configuration to display colors. Here's my setup from the above screenshot.
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.
1313

14-
MacOS & OS X:
14+
**MacOS & OS X:**
1515

1616
```sh
1717
git config --global color.ui true
@@ -22,19 +22,27 @@ 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 with the following command.
2526

26-
## Usage example
27+
```sh
28+
defaults write com.apple.finder AppleShowAllFiles YES; killall Finder /System/Library/CoreServices/Finder.app
29+
```
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.)
2731

28-
A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.
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
2933

30-
## Development setup
34+
**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.
3135

32-
Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
36+
Now let's hide those invisible files again, by pasting the following command into the terminal.
3337

3438
```sh
35-
make install
36-
npm test
39+
defaults write com.apple.finder AppleShowAllFiles NO; killall Finder /System/Library/CoreServices/Finder.app
3740
```
41+
And then restart the terminal app. At this point, we're ready to go!
42+
43+
## Usage example
44+
45+
A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.
3846

3947
## Release History
4048

0 commit comments

Comments
 (0)