From 6fea65a70aba2c2fb0eb2ee50a7d0d9b559d9874 Mon Sep 17 00:00:00 2001 From: patricia-ternes Date: Mon, 20 Nov 2023 14:59:56 +0000 Subject: [PATCH] add install instructions --- docs/usage.rst | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/usage.rst b/docs/usage.rst index 3a266b6..3690f7f 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -3,5 +3,27 @@ Usage Guide To use this code, please clone it onto your local machine: :: - $ https://github.com/ARCTraining/swd3-demo.git + $ git clone https://github.com/ARCTraining/swd3-demo.git + $ cd swd3-demo +Install Hypot +------------- + +To install the hypot package into the environment using `setup.py`, use: :: + + $ python setup.py install + +Using the functions +----------------- + +If you want to create a personalised script, you +can import the hypot modules as follows: :: + + from hypot.calc import squared, addition, sqroot + +Uninstall Hypot +--------------- + +To remove hypot: :: + + $ pip uninstall hypot