added README

2024-02-14 08:40:50 +08:00
parent 336e4e8360
commit 68c41b9b95
1 changed files with 25 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,25 @@
+### Project setup
+
+```bash
+python3 -m venv venv
+venv/bin/python -m pip install -r requirements.txt
+```
+
+### Build
+
+```bash
+venv/bin/python -m build
+```
+
+### Install
+
+```bash
+venv/bin/python -m pipx install dist/sspoc-*.tar.gz
+```
+
+### Run
+```bash
+~/.local/bin/session-security-poc-server
+```
+
+Then open https://localhost:1443 on your favourite browser