From b4d87b5ebb954268d9d0f658ad01cfecb993f6a0 Mon Sep 17 00:00:00 2001 From: Tanner Woody Date: Fri, 4 Apr 2025 11:48:22 -0700 Subject: [PATCH] add installation instructions --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 38f235f6..c8e000fd 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,31 @@ Issues and feature requests are welcome to the repo. ## 💡 Command line usage +### Installation: Non mac + +```bash +pip install gitingest +``` + +### Installation: Mac + +99% of mac users use `brew` as a local package manger. +If Python and pip have been installed with `brew`, it is recommended to stay in this ecosystem with `pipx`. +**If `pipx` does not exist and you are using `brew`, first install the following:** + +```bash +brew install pipx +pipx ensurepath +``` + +Finally, install `gitingest`: + +```bash +pipx install gitingest +``` + +### Usage + The `gitingest` command line tool allows you to analyze codebases and create a text dump of their contents. ```bash