Skip to content

Commit

Permalink
📝 update doc with install.sh & update.sh
Browse files Browse the repository at this point in the history
  • Loading branch information
blyndusk committed Apr 3, 2019
1 parent f136899 commit ee05bf4
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# blyndusk's dotfiles

<p><a href="https://github.com/blyndusk/dotfiles/releases" alt="Release"><img src="https://img.shields.io/github/release/blyndusk/dotfiles.svg"></a></p>

> ⚙️ My personnal dotfiles for MacOS
> ⚙️ ⚙️ my personal dotfiles for MacOS, with automated installation & update
## Get started

Expand All @@ -15,15 +16,22 @@ source install.sh

1. Synchronize **remote files** with **local files**:
> *remote* files are in the *repository*, *local* files are located in `/Users/you`
- if any specified file** doesn't exist**, it'll *create* it.
- if any specified file **doesn't exist**, it'll *create* it.
- after that, sync all specified files
2. Install [Homebrew](https://brew.sh/) and all its **formulae & casks**:
- install `brew`
- update & upgrade `brew`
- install all formulae (`.exports/$BREW_FORMULAE`
- install all formulae (`.exports/$BREW_FORMULAES`
- install all casks (`.exports/$BREW_CASKS`)
- cleanup & diagnosis

`update.sh` will:

1. Synchronize **remote files** with **local files**:
> *remote* files are in the *repository*, *local* files are located in `/Users/you`
- if any specified file **doesn't exist**, it'll *create* it.
- after that, sync all specified files

## License

Under [MIT](https://github.com/blyndusk/dotfiles/blob/master/LICENSE) license.

0 comments on commit ee05bf4

Please sign in to comment.