add comments

Signed-off-by: wangbaiping <[email protected]>

Author: wbpcode

CONTRIBUTING.md

@@ -26,3 +26,7 @@ information on using pull requests.
 
 This project follows [Google's Open Source Community
 Guidelines](https://opensource.google/conduct/).
+
+## Development
+
+See the [Development Guidelines](DEVELOPMENT.md).

DEVELOPMENT.md

@@ -0,0 +1,11 @@
+# How to Develop Proxy Wasm Cpp Host
+
+## Generate compile commands
+
+You could use the following commands to generate the `compile_commands.json` file:
+
+```
+BAZEL_BUILD_OPTION_LIST="--define=engine=multi" ./tools/gen_compdb.py --include_all //test/... //:lib
+```
+
+Then you could use clangd (or other tools the could parse `compile_commands.json`) to setup editors with cross reference, code completion.

README.md

@@ -1,9 +1 @@
 # WebAssembly for Proxies (C++ host implementation)
-
-## Development
-
-You could use the following commands to generate the `compile_commands.json` file:
-
-```
-BAZEL_BUILD_OPTION_LIST="--define=engine=multi" ./tools/gen_compdb.py --include_all //test/... //:lib
-```