https://github.com/webmatze/ruby-wfc
Ruby implementation of wave function collapse algorithm
https://github.com/webmatze/ruby-wfc
Last synced: 18 days ago
JSON representation
Ruby implementation of wave function collapse algorithm
- Host: GitHub
- URL: https://github.com/webmatze/ruby-wfc
- Owner: webmatze
- License: mit
- Created: 2021-10-14T20:48:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-17T23:06:25.000Z (over 4 years ago)
- Last Synced: 2025-01-09T10:28:04.836Z (over 1 year ago)
- Language: Ruby
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Ruby::Wfc
This gemm is a Ruby implementation of the wave function collapse algorithm.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'ruby-wfc'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install ruby-wfc
## 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 the created tag, 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/webmatze/ruby-wfc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/webmatze/ruby-wfc/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Ruby::Wfc project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/webmatze/ruby-wfc/blob/main/CODE_OF_CONDUCT.md).