Add readmes

1 files changed, 18 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d71aa57
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# PM Sched
+
+PM Sched is a user space scheduler, which estimates the power consumption of individual processes and provides the ability to set a system power cap.
+
+## Usage
+Before the Scheduler is run the first time the model has to be trained.
+Data can be collected with the `b` flag and `power_predictor.py` uses the data to train the model.
+
+After that the scheduler can be executed.
+Launching the Scheduler with the `p` flag will use perf to read out performance counter instead of relying on our kernel module.
+`sudo ./power_sched -p` will start a socket in `/tmp/pm-sched`, which can be used to communicate with the scheduler.
+
+The socket supports the following commands
+```
+pid <pid> // get the estimated energy consumption for the process with the given PID and its process tree in Joule. 
+list // lists all PIDs and their estimated power consumption.
+limit <cap> // set a system wide power cap in Watt.
+```
\ No newline at end of file