README.md

wings

A customizable cross language struct and enum file generator.

Requirements

• Nim
• Please
• MkDocs (Documentation)

*Note: There are also other packages needed for deployment due to cross compilation (like gcc-multilib, gcc-arm-linux-gnueabihf, mingw-w64, libevent-dev etc...).

Development Tools (scripts)

• Run mkdocs development server for realtime feedback on changes made docs folder (requires mkdocs)
  • plz docs
• Build release binaries for distribution
  • plz release (This will only build the version compatible to your environment by default. You can do plz release -- --all to try cross-compiling for other environments.)
• Generate / Update the lang folder (src/main/wingspkg/lang) based on the files in the examples/input/templates folder
  • plz lang
• Run tests
  • ./scripts/test.sh (This isn't a proper test for everything. Recommend reading the script, < 20 lines, before running it.)

For some more comprehensive set up / testing procedure, .travis.yml file might be a good place to start looking into.

*Note: Replace plz with ./pleasew if you do not have please installed.

*More note: please might face some permission issues when run in WSL though this is not a please specific issue. Will update with more detailed debugging instructions when I have more time.

Supported languages

• go
• Kotlin
• Nim
• Python
• TypeScript
  • Utility package

Further Documentations

• Usage explanation and examples.
• Code documentation.