tileset_tooling¶ ↑
<img src=“https://github.com/calestar/tileset_tooling/workflows/Ruby/badge.svg?branch=master” alt=“Build Status” /> <img src=“https://badgen.net/rubygems/dt/tileset_tooling” alt=“Number of downloads” /> <img src=“https://badge.fury.io/rb/tileset_tooling.svg” alt=“Gem Version” />
Bits of tooling I use for working with tilesets.
Use¶ ↑
Install if you need to:
sudo apt-get install imagemagick
You can then clone this repository, and run the following in the cloned directory:
bundle install bundle exec tileset_tooling help
Documentation for all the commands can be found in tileset_tooling.rdoc.
Contributing to the project¶ ↑
Local setup¶ ↑
Nothing special is needed to run this tool besides the normal runtime environment. You will need to follow the Use section.
Submitting a Pull Request¶ ↑
If you want to work on something, make sure an issue for that feature/bug exists and is approved. If it is not, you might spend time on something that won’t be merged into master.
Once you select work to be done:
-
Fork the repository
-
Create a branch with either the issue ID as name, or a meaningful name
-
Work on the branch, make sure to rebase often since only branches on tip of master will be accepted
-
Make sure to add new tests/features/documentation in your branch
-
Create pull request, wait for feedback
Generating tileset_tooling.rdoc
¶ ↑
This file contains all the documentation for all the commands. It is automatically generated by gli
when running:
bundle exec tileset_tooling _doc
Validating gem before pushing¶ ↑
Easiest way to validate the gem is to create a RVM virtual environment. In order to do so, simply run the following:
$ gem build tileset_tooling.gemspec $ rvm gemset create project1 $ rvm gemset use project1 $ gem install tileset_tooling-0.0.1.gem $ tileset_tooling help $ rvm gemset use default $ rvm gemset delete project1
Credits¶ ↑
Author¶ ↑
Jean-Sebastien Gelinas (aka calestar).
Copyright¶ ↑
Copyright © 2020 by Jean-Sebastien Gelinas
License¶ ↑
Distributes under the MIT License, see LICENSE.txt in the source distro