Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README with pip install instructions #10

Merged
merged 1 commit into from
Feb 16, 2024
Merged

Update README with pip install instructions #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
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
Loading