Skip to content

Commit 1a68a92

Browse files
committed
update README.md
1 parent 83323b6 commit 1a68a92

File tree

2 files changed

+31
-7
lines changed

2 files changed

+31
-7
lines changed

README.md

+29-6
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@ My personal configuration files for MacOS (Working on Linux support)
55
## Contents:
66

77
Includes files for configuring:
8+
89
- Fish shell
910
- iTerm2
1011
- Neovim
1112
- Tmux
1213
- Hyper.js Terminal
13-
- Phoenix (window and app manager)
14+
- [Phoenix](https://github.com/kasper/phoenix) (window and app manager)
1415

1516
## Default config:
1617

1718
Contains plugins, dependencies and utilities to comfortably work with:
19+
1820
- Javascript
1921
- Elixir
22+
- Erlang
2023
- Rust
2124
- Go
2225
- Crystal
@@ -28,23 +31,37 @@ But you can always customize it to add or remove stuff as you like.
2831
## Use it!
2932

3033
If you like this configuration just clone this repo:
31-
```
34+
35+
```shell
3236
git clone https://github.com/pggalaviz/dotfiles.git ~/.dotfiles
3337
```
38+
3439
then run:
35-
```
40+
41+
```shell
3642
cd ~/.dotfiles && ./install.sh
3743
```
44+
3845
Running `./install.sh` will run different instructions for OSX and Linux.
3946
On OSX, several utilities and dependencies will be installed via **Homebrew, Git & Node** (will ask to install them if not found).
4047

4148
Once Homebrew, Git & Node are detected, these will install by default:
42-
- **tree** (Helps to visualize directory tree on terminal)
43-
- **ripgrep** (Line oriented search tool, better & faster than The Silver Searcher)
49+
4450
- **Python 3** (Programming language)
51+
- **tree** (Helps to visualize directory tree on terminal)
52+
- [**ripgrep**](https://github.com/BurntSushi/ripgrep) (Line oriented search tool, better & faster than The Silver Searcher)
4553
- **reattach-to-user-namespace** (Hack to comfortably work with MacOS clipboard)
54+
- **coreutils** (GNU File, Shell, and Text utilities)
55+
- [**gpg**](https://gnupg.org/) (Encrypt and sign your data and communications)
56+
- **minikube** (For local kubernetes)
57+
- **kubernetes-cli** (The kubernetes CLI tool)
58+
- **redis** (Because it's redis...)
59+
- **direnv** (For easily working with env vars)
60+
- [**bat**](https://github.com/sharkdp/bat) (like `cat` but better)
61+
- [**git-delta**](https://github.com/dandavison/delta) (command line for Git utilities)
4662

4763
Then you'll be prompted to install the following programs/tools:
64+
4865
- Fish shell
4966
- Neovim
5067
- Rust
@@ -75,7 +92,13 @@ In order to fully display UI symbols, you need a 'Powerline patched font', you c
7592
from [https://github.com/powerline/fonts](https://github.com/powerline/fonts), I recomend using
7693
**Source Code Pro Medium**
7794

78-
You can install almost any version of **Ruby** via **rbenv**: `rbenv install **Version**`.
95+
You can install almost any version of **Ruby** via **rbenv**: `rbenv install **Version**`, but if you installed `asdf` better use it instead.
96+
97+
---
98+
99+
**Important:** a symlink to your global `.gitconfig` will be created, make sure you update it with your personal credentials as by default it will contain mine. :)
100+
101+
---
79102

80103
### Linux
81104

scripts/osx.sh

+2-1
Original file line numberDiff line numberDiff line change
@@ -498,7 +498,8 @@ echo_item "Time for some manual stuff, sorry!\n" yellow
498498
echo_item "Tmux"
499499
echo "To install tmux plugins, open tmux, type prefix (<Ctrl> + <space>) + 'I', or 'prefix' + 'U' to update them.\n"
500500
echo_item "Git"
501-
echo "Setup your git config:\ngit config --global user.email "[email protected]"\ngit config --global user.name "PGGalaviz"\n"
501+
echo_item "IMPORTANT - Make sure you add your own Git credentials:" red
502+
echo "Setup your git config:\ngit config --global user.email "[email protected]"\ngit config --global user.name "Your Name"\n"
502503
echo_item "That's it!" blue
503504
echo_item "bye..." blue
504505

0 commit comments

Comments
 (0)