update readme

Author: iliabylich

.gitignore

@@ -18,7 +18,7 @@ benchmark/repos.zip
 benchmark/rust-parser
 benchmark/ruby-parser.rb
 benchmark/repos
-benchmark/c-parser
+benchmark/cpp-parser
 benchmark/filelist
 benchmark/stats
 *.benchmark-out

README.md

@@ -52,3 +52,22 @@ assert_byte_list(result.input.bytes, "2 + 3");
 
 All node classes fully match node structs of the original Rust implementation. You can check [full documentation](https://docs.rs/lib-ruby-parser) (`nodes` module)
 
+# Development
+
++ Clone the repo
++ Set environment variables:
+    + `TARGET` (e.g. `export TARGET=x86_64-apple-darwin`, no default value)
+    + `CC` (e.g. `gcc`)
+    + `BUILD_ENV` (`debug` or `release`, `debug` is the default value)
++ run `make tests/run` to run tests
++ run `make libruby_parser_cpp.a` (or `make libruby_parser_cpp.lib` for MSVC) to get a static library
++ run `make lib-ruby-parser.hpp` to get a header file
+
+# Structure
+
++ Each directory has its own `build.mk` file that is included my the main `Makefile`
++ Rust parser with basic C bindings is located under `ruby-parser-c`.
++ Actual C bindings are located in `*.{h, c}` files in the root directory
++ `scripts` directory contains per-triplet additional configurations for `make`
++ `codegen` directory is a Rust micro-library that does code generation
++ `benchmark` directory contains a set of scripts to compare performance of Rust vs C vs Ripper