CONTRIBUTING.md

Contributing

Running Tests

Please make sure to run the tests (and hopefully add some new ones) before submitting a pull request. The tests use Catch.hpp and are built using cmake:

$ mkdir build; cd build
$ cmake ..
$ make
$ ./tester

Generating Instructions

The C++ x86 instruction template expression are generated using a simple Node script: generate_instructions/generate.js. It's super hacky, but then again, what else can you expect from embedding C++ metaprogramming in Javascript string templates.

To regenerate the instruction:

$ npm install
$ npm run generate

The instructions are written to: include/tasm/isa/x86.h by default.