Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updates to your ReadMe! #560

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updates to your ReadMe! #560

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58d406a
updates readme
Nov 13, 2022
21def3e
updates readme
Nov 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,10 @@ Man pages have been added. Checkout `man colorls`.

[(Back to top)](#table-of-contents)

1. Install Ruby (preferably, version >= 2.6)
2. [Download](https://www.nerdfonts.com/font-downloads) and install a Nerd Font. Have a look at the [Nerd Font README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for installation instructions.
1. Install Ruby (preferably, version >= 2.6 via a version manager like [rbenv](https://github.com/rbenv/rbenv))
2. [Download](https://www.nerdfonts.com/font-downloads) and install a Nerd Font so you can see the library icons. Have a look at the [Nerd Font README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for installation instructions. We're using "Hack Nerd Font" for this guide.

*Note for MacOS users using the stock terminal - Please enable Nerd Font at Terminal > Preferences > Profiles > Text > Font. Click `Change..` and select `Hack Nerd Font` - Regular*

*Note for `iTerm2` users - Please enable the Nerd Font at iTerm2 > Preferences > Profiles > Text > Non-ASCII font > Hack Regular Nerd Font Complete.*

Expand All @@ -138,10 +140,14 @@ Man pages have been added. Checkout `man colorls`.
source $(dirname $(gem which colorls))/tab_complete.sh
```

*Don't forget to restart your terminal*

5. Start using `colorls` :tada:

6. Have a look at [Recommended configurations](#recommended-configurations) and [Custom configurations](#custom-configurations).

If you're having trouble following the installation guide above, here's a [video](https://replayable.io/replay/63703dff5b09d400696d2663/?share=R2Twi0SdQiqg8cxHyzem6g) reproducing steps 2 to 6.

# Recommended configurations

[(Back to top)](#table-of-contents)
Expand Down