Skip to content

Commit

Permalink
Merge pull request #23 from CrowdJustice/add-install-command
Browse files Browse the repository at this point in the history
updating readme
  • Loading branch information
phil-bell authored Mar 4, 2022
2 parents ae1657b + 560a24c commit 8b71015
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# `legl-dev`

**Usage**:
## [Main documentation](https://www.notion.so/legl/legl-dev-ef854acaa12345339cc3b4cdde1029e1)

### Usage

```console
$ legl-dev [OPTIONS] COMMAND [ARGS]...
```

**Install**
### Install

```console
$ pip install -e git+https://github.com/CrowdJustice/legl-dev.git#egg=legl-dev
$ pip install git+https://github.com/CrowdJustice/legl-dev.git
```
This will install the remote repo in editable mode, so when changes are merged into `main` you local
install of `legl-dev` will be updated.

**Development**
### Development

When adding to legl-dev you should pull down the repo and install it in editable mode from the
location you will be editable it from. For example
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
from setuptools import setup

version = "1.1.0"
version = "1.1.1"

packages = ["legl_dev"]

Expand Down

0 comments on commit 8b71015

Please sign in to comment.