diff --git a/tool/rawstr4c/doc/01-Develop.md b/tool/rawstr4c/doc/01-Develop.md new file mode 100644 index 0000000..001a280 --- /dev/null +++ b/tool/rawstr4c/doc/01-Develop.md @@ -0,0 +1,90 @@ + + +# Develop `rawstr4c` + +## Dependencies and Dev environment + +Please install these first: + + 1. [rakudo] + 2. [just] + +
+ + + +## Get code + +**Please make sure to use the dev branch for development** + +```bash +git clone https://gitee.com/RubyMetric/chsrc.git -b dev +``` + +
+ + + +## Run + +```bash +just rawstr4c +``` + +```bash +zef install . + +rawstr4c + +zef uninstall rawstr4c +``` + +
+ + + +## Debug + +```bash +just rawstr4c --debug +# Note: there must be an = between option value and option +just rawstr4c --debug=parser +just rawstr4c --debug=generator +``` + +
+ + + +## Test + +Run test scripts + +```bash +cd test + +raku ./xx-file.rakutest +``` + +Test executable file + +```bash +just rawstr4c +``` + +
+ + + +[rakudo]: https://rakudo.org/ +[just]: https://github.com/casey/just