Skip to content

Commit

Permalink
add install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
patricia-ternes committed Nov 20, 2023
1 parent 8734841 commit 6fea65a
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 6fea65a

Please sign in to comment.