Skip to content

Commit

Permalink
Merge pull request #3 from gozeloglu/add-build-cmd-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ozansz authored Jul 26, 2022
2 parents cd19882 + c7ea452 commit e2e61b4
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,19 @@ Installing `gls` on your machine is pretty simple: just clone the repo and run `
```bash
$ git clone github.com/ozansz/gls
$ cd gls
$ go run cmd/gls.go
$ go build cmd/gls.go
```

After you run `go build` command, an executable file name `gls` is created. You can modify `.bashrc`, `.zshrc`, or another
file depending on the terminal you are using by adding the full path of the executable file.

```bash
# Open .zshrc, .bashrc, or whatever you are using with a text editor.
$ alias gls='~/gls/gls' # add full path of the gls executable file.
# Save file and exit.
$ source .bashrc
# Reopen your terminal and try the command
$ gls -path gls
```

> An install script will come in next feature update and you will be able to just run `gls` on your terminal!
Expand Down

0 comments on commit e2e61b4

Please sign in to comment.