summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 12 insertions, 7 deletions
diff --git a/README.md b/README.md
index 1aa227e..9490b20 100644
--- a/README.md
+++ b/README.md
@@ -107,14 +107,19 @@ combination of hash algorithm and prime number size. This may be of
use in deciding which pair of parameters to use in the unlikely
event that the defaults are unacceptable.
-Installation:
- python setup.py install
+Installation from source:
+```
+ $ python setup.py install
+```
Documentation:
- cd srp/doc
- sphinx-build -b html . <desired output directory>
+```
+ $ cd srp/doc
+ $ sphinx-build -b html . <desired output directory>
+```
Validity & Performance Testing:
- python setup.py build
- python test_srp.py
-
+```
+ $ python setup.py build
+ $ python test_srp.py
+```