Browse Source

add example call, dependencies and setup to README.md

ari-test 1 year ago
parent
commit
bed7ec50bb
1 changed files with 18 additions and 3 deletions
  1. 18
    3
      README.md

+ 18
- 3
README.md View File

@@ -1,5 +1,20 @@
1 1
 # json-adapter-perf
2 2
 
3
-benchmarking performance of the json-adapter
4
-
5
-includes a number of simple messages + key material
3
+benchmarking performance of the json-adapter
4
+
5
+includes a number of simple messages + key material
6
+
7
+`$ python3 run_perf.py data/mime_mails_with_key/`
8
+    will run the benchmark with supplied test data and output a FlameGraph of the run to `/tmp/perf.svg`. Web browsers may be better at rendering this svg then your image viewer.
9
+
10
+# Dependencies / Setup
11
+
12
+This depends on
13
+- brendangreggs's `FlameGraph` which is a submodule of this repo
14
+- `perf` (which on debian is in `linux-base`)
15
+- `pep-json-server` which it looks for in your `$HOME` - if you're running enigmail/pEp you're good
16
+- `enigmail-linux`, which is also a submodule of this repo (Build infrastructure for the pEp-part of enigmail/pEp
17
+- `perf` being able to collect stats: as root you can enable this by<br/>
18
+  `echo 2 > /proc/sys/kernel/perf_event_paranoid`
19
+
20
+if you're on linux, install enigmail2 in the default pEp-mode, `git submodule update --init` and you should be good to go.

Loading…
Cancel
Save