Browse Source

Tweaking README for readability

sshsshy 1 year ago
parent
commit
c9b2038857
1 changed files with 25 additions and 1 deletions
  1. 25 1
      README.md

+ 25 - 1
README.md

@@ -1,5 +1,8 @@
 To reproduce our experiments:
+
+
 1) Run ./build_dockers.sh to create the docker images to reproduce XPIR, SealPIR and ZeroTrace microbenchmarks
+
 2) Run ./reproduce_results.sh to run all the experiments in their respective dockers, populate the plotter folder with the output log files for these libraries and generate the graphs from these output logs.
 
 _______________________________________________________________________________
@@ -7,28 +10,49 @@ _______________________________________________________________________________
 To run individual microbenchmarks on their own:
 
 For SealPIR microbenchmark:
+
 1) Go to the SPIR_docker folder
+
 2) Build the SealPIR docker: docker build -t spir_docker .
+
 3) Enter the docker with: docker run -it spir_docker
+
 4) Set the desired configs for the experiments in config.sh
+
 5) Run ./run_sealpir.sh to run the experiments and generate the output logfile (by default log_SEALPIR unless tweaked in config.sh)
+
 6) Copy the output file out of the docker to the plotter folder docker cp -r <docker_id>:/pir/Results/XPIR ./plotter
 
 
+
 For the XPIR microbenchmark:
+
 1) Go to the XPIR_docker folder
+
 2) Build the XPIR docker: docker build -t xpir_docker .
+
 3) Enter the docker with: docker run -it xpir_docker
+
 4) Set the desired configs for the experiments in config.sh
-5) Run ./run_xpir.sh to run the experiments and generate the output folder (by defaulr /pir/Results/ within the docker)
+
+5) Run ./run_xpir.sh to run the experiments and generate the output folder (by default /pir/Results/ within the docker)
+
 6) Copy the output folder out of the docker to the main scripts folder docker cp <docker_id>:/pir/log_Results ./plotter
 
 
+
 For the ZeroTrace microbenchmark:
+
 1) Go to the ZT_docker folder
+
 2) Build the ZeroTrace docker: docker build -t zt_docker .
+
 3) Start and enter the docker with : docker run --device /dev/isgx -it zt_docker bash -c "start-aesmd && exec bash" 
+
 4) Set the desired configs in config.sh
+
 5) run ./zt_lsoram.sh to generate the LinearScan ORAM benchmarks
+
 6) run ./zt_hsoram.sh to generate the Circuit or Path ORAM benchmarks and use config.sh to set appropriate ORAM parameters for them.
+
 7) Copy the results to outside of the docker for replotting graphs with our grapher script: docker cp <docker_id>:/pir/log_CIRCUITORAM ./plotter