Skip to content

Commit

Permalink
Update README with pip install instructions (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
markroth8 authored Feb 16, 2024
1 parent 75c5a63 commit 2c10ae5
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,16 @@ and null (never run). To use memento for distributed computation or shared stora
plugins can be used.


# Quick Start
# Installation
If you just want to use Memento, you can easily install it from the PyPI package repository, as follows:

```bash
$ pip install twosigma-memento
```

Memento is tested with Python 3.8 and above, and should work on Linux, Windows and Mac.

# Development Quick Start
The following instructions should get you from a git clone to a working build of Memento.
These instructions are tested on Linux and Windows but should work in other environments
as well.
Expand All @@ -28,8 +37,6 @@ as well.
You need a Python environment with hatch installed:

```bash
$ python --version
Python 3.11.1
$ pip install hatch
```

Expand Down

0 comments on commit 2c10ae5

Please sign in to comment.