wag/README.md

57 lines
1.3 KiB
Markdown
Raw Normal View History

2020-03-29 20:09:00 +13:00
# WAG - The WebAssembly Code Generator
2020-03-28 16:28:17 +13:00
2020-03-29 20:09:00 +13:00
This Ruby gem allows you to generate WebAssembly programs programatically.
2020-03-28 16:28:17 +13:00
2020-03-29 20:09:00 +13:00
## Example
```ruby
WAG::Module.new.build do
memory(1)
export('memory', :memory)
export('hello', :$hello)
func(:$hello) do
result(:i32)
i32.const(16)
end
data do
i32.const(16)
<< "Hello World\00"
end
end
```
2020-03-28 16:28:17 +13:00
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'wag'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install wag
## Usage
TODO: Write usage instructions here
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wag.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).