diff --git a/README.md b/README.md index 9bc764b..0b65283 100644 --- a/README.md +++ b/README.md @@ -117,28 +117,23 @@ To run the library, you need: conda activate tinytroupe ``` 4. Make sure you have eihter Azure OpenAI or OpenAI API keys set as environment variables, as described in the [Pre-requisites](#pre-requisites) section. -5. Install the library **from this repository, not PyPI**: +5. Clone the repository, as we'll perform a local install (we **will not install from PyPI**): + ```bash + git clone https://github.com/microsoft/tinytroupe + cd tinytroupe + ``` + +6. Install the library **from this repository, not PyPI**: ```bash - pip install git+https://github.com/microsoft/tinytroupe.git + pip install . ``` -6. You can now use TinyTroupe to create your simulations 🥳. If you want to run the examples in the +7. You can now run the examples in the [examples/](./examples/) folder or use TinyTroupe to create your simulations 🥳. If you want to run the examples in the [examples/](./examples/) folder or modify TinyTroupe itself, however, you should clone the repository as described below. -### Cloning the repository: examples and local development - -If you want to run the examples in the [examples/](./examples/) folder, you can simply clone the repository and run the examples directly from there: -```bash -git clone https://github.com/microsoft/tinytroupe -cd tinytroupe -``` - -Further, if you want to modify TinyTroupe itself, you can install it from the local clone: -```bash -pip install . -``` +### Local development -or, in editable mode (i.e., changes to the code will be reflected immediately): +If you want to modify TinyTroupe itself, you can install it in editable mode (i.e., changes to the code will be reflected immediately): ```bash pip install -e . ``` diff --git a/docs/github-social-preview-2.png b/docs/github-social-preview-2.png new file mode 100644 index 0000000..5fc2701 Binary files /dev/null and b/docs/github-social-preview-2.png differ diff --git a/docs/github-social-preview.png b/docs/github-social-preview.png new file mode 100644 index 0000000..7991fd2 Binary files /dev/null and b/docs/github-social-preview.png differ