From b841b14774b93e3aec5565d6a86de984d3fa7b8e Mon Sep 17 00:00:00 2001 From: Kirill Markin Date: Sat, 8 Jun 2024 13:27:13 +0200 Subject: [PATCH] pip instal instruction --- README.md | 64 ++++++++++++++++++++++++------------------------------- 1 file changed, 28 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 5283223..63af310 100644 --- a/README.md +++ b/README.md @@ -10,47 +10,14 @@ - Copies the generated text representation to the clipboard for easy sharing. - Easy to install and use via `pip` and Homebrew. - - -### Install Locally - -To install `repo-to-text` locally for development, follow these steps: - -1. Clone the repository: - - ```bash - git clone https://github.com/kirill-markin/repo-to-text - cd repo-to-text - ``` - -2. Install the package locally: - - ```bash - pip install -e . - ``` - -### Installing Dependencies - -To install all the required dependencies, run the following command: - -```bash -pip install -r requirements.txt +pip install repo-to-text ``` ## Usage @@ -85,7 +52,32 @@ You can customize the behavior of `repo-to-text` with the following options: The generated text file will include the directory structure and contents of each file. For a full example, see the [example output for this repository](examples/example_repo_snapshot_2024-06-08-10-30-33-UTC.txt). -## Running Tests +## Install Locally + +To install `repo-to-text` locally for development, follow these steps: + +1. Clone the repository: + + ```bash + git clone https://github.com/kirill-markin/repo-to-text + cd repo-to-text + ``` + +2. Install the package locally: + + ```bash + pip install -e . + ``` + +### Installing Dependencies + +To install all the required dependencies, run the following command: + +```bash +pip install -r requirements.txt +``` + +### Running Tests To run the tests, use the following command: