Skip to content

Commit 2e9095a

Browse files
author
Andrea Giardina
committed
Basic documentation to install binaries added
1 parent 720d96d commit 2e9095a

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

INSTALL.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Install
2+
3+
## Binary Installation
4+
5+
git-cdflow provides 64-bit installation for GNU/Linux and Mac OS X.
6+
7+
1. Download the tar.gz file for your platform from the [release page](https://github.com/Etiqa/git-cdflow/releases)
8+
2. Extract the archive
9+
```bash
10+
tar xvzf git-cdflow.tar.gz
11+
```
12+
3. `cd` to the directory you extracted the archive, for example `cd /Users/johndoe/git-cdflow`
13+
4. `cd` to the bin subdirectory `cd bin`
14+
5. Test that the toolkit is functional
15+
```bash
16+
./git-cdflow version
17+
```
18+
6. Append the git-cdflow bin directory to your `PATH` environment variable. There are different ways to do it, for example adding the following row to your `~/.bashrc` file
19+
```bash
20+
export PATH=$PATH:/Users/johndoe/git-cdflow/bin
21+
```
22+
7. Verify that the binaries will be found by the shell:
23+
```bash
24+
source ~/.bashrc
25+
which git-cdflow
26+
```
27+
8. Your configuration should be done and git-cdflow should be recognized as a git plugin, so you can run it without the dash:
28+
```bash
29+
git cdflow help
30+
```

0 commit comments

Comments
 (0)