Skip to content

Commit

Permalink
Merge pull request #14 from microsoft/development
Browse files Browse the repository at this point in the history
Changes install instructions, as previous one was causing issues.
  • Loading branch information
paulosalem authored Nov 11, 2024
2 parents c26a0f9 + 99b8fe3 commit e13e589
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 .
```
Expand Down
Binary file added docs/github-social-preview-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/github-social-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e13e589

Please sign in to comment.