From fc20e6c5f6c2784d37ee5c78915b7fea788c8632 Mon Sep 17 00:00:00 2001 From: volitank Date: Sun, 31 Oct 2021 15:53:19 -0400 Subject: [PATCH] Small documentation change There will likely be a lot of small changes to the documentation --- README.md | 4 ++++ docs/source/sections/initial_setup.rst | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/README.md b/README.md index 6eeef7c..5b357a5 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ `$ pip install https://github.com/volitank/pyshell/releases/download/v1.0.0.a1/pyshell-1.0.0a1.tar.gz` + To install the directly from the source code you can use + + `$ pip install https://github.com/volitank/pyshell/archive/refs/heads/main.tar.gz` + # Usage from pyshell import pyshell diff --git a/docs/source/sections/initial_setup.rst b/docs/source/sections/initial_setup.rst index e018747..35f7392 100644 --- a/docs/source/sections/initial_setup.rst +++ b/docs/source/sections/initial_setup.rst @@ -15,6 +15,12 @@ or $ pip install https://github.com/volitank/pyshell/releases/download/v1.0.0.a1/pyshell-1.0.0a1.tar.gz +To install the directly from the source code you can use + +.. code-block:: console + + $ pip install https://github.com/volitank/pyshell/archive/refs/heads/main.tar.gz + .. _initialization: Initialization