Add README.org

README.org

@@ -0,0 +1,34 @@
+#+title: Readme
+
+* Installation
+
+* Usage
+
+#+begin_src sh :results output
+annotator --help
+#+end_src
+
+#+RESULTS:
+#+begin_example
+Usage: annotator [OPTIONS] files...
+
+A tool to semi-automatically add Coverity source-code annotations based on found defects.
+
+
+  -v         --verbose             be more verbose, pass multiple times to increase verbosity
+  -i         --inplace             replace source-file after inserting annotations
+  -V         --version             show full version information
+             --short-version       show just the version number
+  -h         --help                show usage information
+  -b         --batch               run in batch mode, i.e. do not ask any questions
+  -a         --all                 handle all defects not just Newest
+  -C[NUM]    --context[=NUM]       specify how much context should be shown around a violation
+  -t STRING  --todo-marker=STRING  override the default TODO marker with a custom string
+  -A FILE    --annotations=FILE    load automatic annotation rules
+                                     some examples:
+                                        Intentional (Rule "rule_1") "some reason"
+                                        FalsePositive (Rule "rule_1") "some reason"
+                                        ToDo (Rule "rule_1")
+                                        # a comment
+                                        -- another comment
+#+end_example