Skip to content

Commit 320d650

Browse files
authored
Merge pull request #252 from Twoody/installation-instructs
add installation instructions
2 parents 688c1d0 + b4d87b5 commit 320d650

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,31 @@ Issues and feature requests are welcome to the repo.
5050

5151
## 💡 Command line usage
5252

53+
### Installation: Non mac
54+
55+
```bash
56+
pip install gitingest
57+
```
58+
59+
### Installation: Mac
60+
61+
99% of mac users use `brew` as a local package manger.
62+
If Python and pip have been installed with `brew`, it is recommended to stay in this ecosystem with `pipx`.
63+
**If `pipx` does not exist and you are using `brew`, first install the following:**
64+
65+
```bash
66+
brew install pipx
67+
pipx ensurepath
68+
```
69+
70+
Finally, install `gitingest`:
71+
72+
```bash
73+
pipx install gitingest
74+
```
75+
76+
### Usage
77+
5378
The `gitingest` command line tool allows you to analyze codebases and create a text dump of their contents.
5479

5580
```bash

0 commit comments

Comments
 (0)