From f46d343ea6ba5ac3eed29eaa09db7a9f783441da Mon Sep 17 00:00:00 2001
From: Youngjoon Lee <5462944+youngjoon-lee@users.noreply.github.com>
Date: Mon, 13 May 2024 08:49:09 +0900
Subject: [PATCH] add readme and reorganize imports

---
 mixnet/v2/sim/README.md     | 10 ++++++++++
 mixnet/v2/sim/main.py       |  2 +-
 mixnet/v2/sim/node.py       |  4 ++--
 mixnet/v2/sim/p2p.py        |  2 +-
 mixnet/v2/sim/simulation.py |  4 ++--
 5 files changed, 16 insertions(+), 6 deletions(-)
 create mode 100644 mixnet/v2/sim/README.md

diff --git a/mixnet/v2/sim/README.md b/mixnet/v2/sim/README.md
new file mode 100644
index 0000000..8258d09
--- /dev/null
+++ b/mixnet/v2/sim/README.md
@@ -0,0 +1,10 @@
+# Mixnet v2 Simulation
+
+## How to run
+
+Make sure that all dependencies specified in the `requirements.txt` in the project root, and run the following command to run the simulation:
+```bash
+python main.py
+```
+
+TODO: Add more details
\ No newline at end of file
diff --git a/mixnet/v2/sim/main.py b/mixnet/v2/sim/main.py
index 7224379..fc0e4f6 100644
--- a/mixnet/v2/sim/main.py
+++ b/mixnet/v2/sim/main.py
@@ -1,4 +1,4 @@
-from mixnet.v2.sim.simulation import Simulation
+from simulation import Simulation
 
 if __name__ == "__main__":
     sim = Simulation()
diff --git a/mixnet/v2/sim/node.py b/mixnet/v2/sim/node.py
index b2d35b8..7e1744a 100644
--- a/mixnet/v2/sim/node.py
+++ b/mixnet/v2/sim/node.py
@@ -4,8 +4,8 @@ import simpy
 from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.primitives.asymmetric.x25519 import X25519PrivateKey, X25519PublicKey
 
-from mixnet.v2.sim.sphinx import SphinxPacket, Attachment
-from mixnet.v2.sim.p2p import P2p
+from sphinx import SphinxPacket, Attachment
+from p2p import P2p
 
 
 class Node:
diff --git a/mixnet/v2/sim/p2p.py b/mixnet/v2/sim/p2p.py
index 9397830..409bcc0 100644
--- a/mixnet/v2/sim/p2p.py
+++ b/mixnet/v2/sim/p2p.py
@@ -2,7 +2,7 @@ import random
 
 import simpy
 
-from mixnet.v2.sim.sphinx import SphinxPacket
+from sphinx import SphinxPacket
 
 
 class P2p:
diff --git a/mixnet/v2/sim/simulation.py b/mixnet/v2/sim/simulation.py
index 1d3a422..a5bd3e4 100644
--- a/mixnet/v2/sim/simulation.py
+++ b/mixnet/v2/sim/simulation.py
@@ -1,7 +1,7 @@
 import simpy
 
-from mixnet.v2.sim.node import Node
-from mixnet.v2.sim.p2p import P2p
+from node import Node
+from p2p import P2p
 
 
 class Simulation: