Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.03 KB

README.md

File metadata and controls

50 lines (34 loc) · 1.03 KB

Build Status

binmap.cr

Binary mapping macro for crystal, building as standalone for now with plans to cleanup and PR to stdlib.

Installation

Add this to your application's shard.yml:

dependencies:
  binmap:
    github: maxpowa/binmap.cr

Usage

require "binmap"

class BasicMapping
  Binary.mapping(
    foo: UInt8,
    bar: Int16,
    baz: Float32
  )
end

BasicMapping.new(io)

TODO: Document supported types

Development

TODO: Write development instructions here

Contributing

  1. Fork it ( https://github.com/maxpowa/binmap.cr/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

  • maxpowa Max Gurela - creator, maintainer
  • RX14 Chris Hobbs - moral support