Skip to content

Commit

Permalink
fix(readme) Add screenshots, travis badge
Browse files Browse the repository at this point in the history
  • Loading branch information
musq committed Aug 6, 2019
1 parent 39b4c57 commit 47cdc06
Showing 1 changed file with 103 additions and 9 deletions.
112 changes: 103 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ashish’s dotfiles

![Travis](https://img.shields.io/travis/com/musq/dotfiles.svg)
![Travis](https://img.shields.io/travis/musq/dotfiles/master)
![Version](https://img.shields.io/github/release/musq/dotfiles.svg)
![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)
![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)
Expand Down Expand Up @@ -63,21 +63,27 @@ work on —
- Ubuntu 16.04+
- MacOS Mojave+ (Nix might not work on some packages)

It is strongly recommended to use [dotfiles-system](https://github.com/musq/dotfiles-system) to install [`Nix`](https://nixos.org/nix) beforehand.
It is **strongly recommended** to use
[dotfiles-system](https://github.com/musq/dotfiles-system) to install
[`Nix`](https://nixos.org/nix) beforehand.

## Install

The setup process will:

- Download the dotfiles on your computer (by default it will suggest
`~/projects/dotfiles`)
- Take versioned [backup](src/os/create_backup.sh) of files that might be changed and store them
in `~/.backups/dotfiles-backup/v*`
- [Symlink](src/os/create_symbolic_links.sh) the [`config`](src/config), [`gnupg`](src/gnupg), [`shell`](src/shell), and [`ssh`](src/ssh) files
- Take versioned [backup](src/os/create_backup.sh) of files that might
be changed and store them in `~/.backups/dotfiles-backup/v*`
- [Symlink](src/os/create_symbolic_links.sh) the [`config`](src/config),
[`gnupg`](src/gnupg), [`shell`](src/shell), and [`ssh`](src/ssh) files
- [Harden](src/os/contract/harden.sh) `ssh` and `gnupg` direcories
- [Install](src/os/install/nix) packages using `Nix`
- Set custom [`macOS`](src/os/preferences/macos), [`Debian/Ubuntu`](src/os/preferences/debian) preferences
- Install [`fonts`](src/os/contract/fonts.sh), [`tmux plugins`](src/os/install/helpers.sh), and [`vim plugins`](src/os/contract/vim.sh)
- Set custom [`macOS`](src/os/preferences/macos),
[`Debian/Ubuntu`](src/os/preferences/debian) preferences
- Install [`fonts`](src/os/contract/fonts.sh),
[`tmux plugins`](src/os/install/helpers.sh), and
[`vim plugins`](src/os/contract/vim.sh)

### One-line installer

Expand Down Expand Up @@ -123,6 +129,90 @@ Pass `-y` or `--yes` to automatically answer yes to all the questions.

## Screenshots

### Install in action

<img
src="https://raw.githubusercontent.com/musq/assets/master/dotfiles/install.gif"
alt="Setup process in action"
width="100%">

<br>

### Previews

<table>
<tbody>
<tr>
<td>
<img src="https://raw.githubusercontent.com/musq/assets/master/dotfiles/fzf-cd.png" alt="Jump directory using fzf" width="100%">
</td>
<td>
<img src="https://raw.githubusercontent.com/musq/assets/master/dotfiles/git-b.png" alt="Detailed git branches list" width="100%">
</td>
</tr>
<tr align="center">
<td>Fuzzy directory jump</td>
<td>List git branches</td>
</td>
</tbody>
</table>

<br>

<table>
<tbody>
<tr>
<td>
<img src="https://raw.githubusercontent.com/musq/assets/master/dotfiles/git-l.png" alt="Git log" width="100%">
</td>
<td>
<img src="https://raw.githubusercontent.com/musq/assets/master/dotfiles/git-rf.png" alt="Git reflog" width="100%">
</td>
</tr>
<tr align="center">
<td>Git log</td>
<td>Git reflog</td>
</td>
</tbody>
</table>

<br>

<table>
<tbody>
<tr>
<td>
<img src="https://raw.githubusercontent.com/musq/assets/master/dotfiles/git-d.png" alt="Git diff (unified)" width="100%">
</td>
<td>
<img src="https://raw.githubusercontent.com/musq/assets/master/dotfiles/git-i.png" alt="Git icdiff (side-by-side)" width="100%">
</td>
</tr>
<tr align="center">
<td>Git diff (unified)</td>
<td>Git icdiff (side-by-side)</td>
</td>
</tbody>
</table>

<br>

<table>
<tbody>
<tr>
<td>
<img src="https://raw.githubusercontent.com/musq/assets/master/dotfiles/fzf_git_log.png" alt="Fuzzy git log with preview using fzf" width="100%">
</td>
<td>
<img src="https://raw.githubusercontent.com/musq/assets/master/dotfiles/tmux.png" alt="Tmux" width="100%">
</td>
</tr>
<tr align="center">
<td>Fuzzy git log with preview</td>
<td>Tmux</td>
</td>
</tbody>
</table>



Expand All @@ -143,12 +233,16 @@ or submit PRs.

See [contributing guidelines](CONTRIBUTING.md).

If you decide to **fork this project**, do not forget to substitute my username with your own in the [`one-line installer`](#one-line-installer) and in the [`setup script`][setup line]
If you decide to **fork this project**, do not forget to substitute my
username with your own in the
[`one-line installer`](#one-line-installer) and in the
[`setup script`][setup line]

## License

- The code is available under [GNU GPL v3, or later](LICENSE) license
- Parts taken from other sources are still available under their original licenses
- Parts taken from other sources are still available under their
original licenses

<!-- Link labels: -->

Expand Down

0 comments on commit 47cdc06

Please sign in to comment.