Update README.md for reference NN runtime

- Remove ambigous word `Design` from tile ofsecond chapter
- Add two comment styles for convenience

Signed-off-by: Hyung-Kyu Choi <hk0110.choi@samsung.com>

diff --git a/src/runtime/ref/README.md b/src/runtime/ref/README.md
index 27b9bba..8449864 100644 (file)
--- a/src/runtime/ref/README.md
+++ b/src/runtime/ref/README.md
@@ -21,7 +21,7 @@ Therefore, we decide to take below two approaches in parallel.
 Therefore we decide to implement a reference NN runtime with Plan A for quick development without concrete design.
 We will follow below philosophies to achieve a main goal.
 
-## Design philosophies for this reference implementation
+## Philosophies of a reference NN runtime
 
 We will follow below philosophies until we have a working stack of NN runtime.
 
@@ -33,3 +33,22 @@ We will follow below philosophies until we have a working stack of NN runtime.
   - Don't share existing file of `experiments/android_nn` for our own implementation.
 
 Simply keep as much as possible the code of `experiments/android_nn` when importing and introduce new files for our own implementation.
+
+## Coding Guidelines
+
+We will use following two comment styles for our conveniences.
+
+For those code copied from Android NN but not used yet, use `#if 0 // REF-ANN` to exclude from source code.
+Later you can just remove above `#if 0`, `#endif` and comments when we decide to compile/update it in our reference NN runtime.
+```
+#if 0 // REF-ANN
+  original code from Android NN without any modification and not used yet
+#endif
+```
+
+If you want to leave `TODO` comment, let's use `TODO-NNRT` to distinguish from other `TODO`.
+
+```
+ // TODO-NNRT : Todo for a NN runtime implemenation
+```
+