diff --git a/README.md b/README.md index 11e9b89..3979826 100644 --- a/README.md +++ b/README.md @@ -20,23 +20,33 @@ Early stage experiment ### Using pip: -From PyPI - ```sh pip install offlinedatasci ``` -From GitHub (latest development version) +### Using pipx: + +To install just the command line interface (CLI) we recommend [pipx](https://pipx.pypa.io/). [Install pipx](https://pipx.pypa.io/stable/installation/) and then run: + +```sh +pipx install offlinedatasci +``` + +### Installing development versions + +#### Directly From GitHub ```sh pip install git+https://git@github.com/carpentriesoffline/offlinedatasci.git ``` -### For local development: +#### Locally Clone the repository and from the root directory run: ```sh +git clone https://github.com/carpentriesoffline/offlinedatasci.git +cd offlinedatasci pip install . ``` diff --git a/docs/getting-started.md b/docs/getting-started.md index 0676156..450dae8 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -2,6 +2,22 @@ offlinedatasci comes with two interfaces, a command line interface and a Python interface. +## Installation + +### Using pip: + +```sh +pip install offlinedatasci +``` + +### Using pipx: + +To install just the command line interface (CLI) we recommend [pipx](https://pipx.pypa.io/). [Install pipx](https://pipx.pypa.io/stable/installation/) and then run: + +```sh +pipx install offlinedatasci +``` + ## Command line interface ### Installing everything