diff options
| author | realtradam <[email protected]> | 2021-07-09 03:50:04 -0400 |
|---|---|---|
| committer | realtradam <[email protected]> | 2021-07-09 03:50:04 -0400 |
| commit | a8c84b1bd0ee1fef6891032f9d3d4b8a8b5fc9f2 (patch) | |
| tree | 4fee86ae8484f80f3cc3132efc2329e0164d7cce | |
| parent | 0fbb48c7b0ef7070664945ef22840b0bfbfe9153 (diff) | |
| download | FelECS-a8c84b1bd0ee1fef6891032f9d3d4b8a8b5fc9f2.tar.gz FelECS-a8c84b1bd0ee1fef6891032f9d3d4b8a8b5fc9f2.zip | |
released as gem
| -rw-r--r-- | Gemfile.lock | 2 | ||||
| -rw-r--r-- | README.md | 39 | ||||
| -rw-r--r-- | README.mdown | 2 | ||||
| -rw-r--r-- | felflame.gemspec | 24 | ||||
| -rw-r--r-- | lib/felflame/version.rb | 2 |
5 files changed, 20 insertions, 49 deletions
diff --git a/Gemfile.lock b/Gemfile.lock index 6a25741..8fcbb4f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - felflame (1.0.0.beta1) + felflame (1.0.0) GEM remote: https://rubygems.org/ diff --git a/README.md b/README.md deleted file mode 100644 index 467cf39..0000000 --- a/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# Felflame - -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/felflame`. To experiment with that code, run `bin/console` for an interactive prompt. - -TODO: Delete this and the text above, and describe your gem - -## Installation - -Add this line to your application's Gemfile: - -```ruby -gem 'felflame' -``` - -And then execute: - - $ bundle install - -Or install it yourself as: - - $ gem install felflame - -## Usage - -TODO: Write usage instructions here - -## Development - -After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/felflame. - -## License - -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/README.mdown b/README.mdown index 3149178..d319066 100644 --- a/README.mdown +++ b/README.mdown @@ -99,6 +99,8 @@ If all of this sounds very confusing, don't worry. A video tutorial series is in # Usage +To use FelFlame simply install the gem using `gem install felflame` or using bundler `bundle add felflame` and then require it in your project like so: `require 'felflame'`. Working outside of the gem for rendering engines that do not support the usage of gems is planned a planned feature in the works. + ## Entities ### Creation diff --git a/felflame.gemspec b/felflame.gemspec index 4ea9dd5..b41c7fb 100644 --- a/felflame.gemspec +++ b/felflame.gemspec @@ -5,20 +5,20 @@ require_relative "lib/felflame/version" Gem::Specification.new do |spec| spec.name = "felflame" spec.version = Felflame::VERSION - spec.authors = ["realtradam"] - spec.email = ["[email protected]"] + spec.authors = ["Tradam"] + spec.email = ["[email protected]"] - spec.summary = "TODO: Write a short summary, because RubyGems requires one." - spec.description = "TODO: Write a longer description or delete this line." - spec.homepage = "TODO: Put your gem's website or public repo URL here." + spec.summary = "The Engine Agnostic ECS Ruby Framework" + #spec.description = "TODO: Write a longer description or delete this line." + spec.homepage = "https://felflame.tradam.fyi" spec.license = "MIT" spec.required_ruby_version = ">= 2.4.0" - spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'" + #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'" spec.metadata["homepage_uri"] = spec.homepage - spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here." - spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here." + spec.metadata["source_code_uri"] = "https://github.com/realtradam/FelFlame" + #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here." # Specify which files should be added to the gem when it is released. # The `git ls-files -z` loads the files in the RubyGem that have been added into git. @@ -31,6 +31,14 @@ Gem::Specification.new do |spec| # Uncomment to register a new dependency of your gem # spec.add_dependency "example-gem", "~> 1.0" + spec.add_development_dependency 'minitest-reporters', '~> 1.4', '>= 1.4.3'#, require: false + spec.add_development_dependency 'rspec', '~> 3.10' + spec.add_development_dependency 'simplecov', '~> 0.21.2'#, require: false + spec.add_development_dependency 'simplecov-console', '~> 0.9.1' + spec.add_development_dependency 'simplecov_json_formatter', '~> 0.1.3'#, require: false + spec.add_development_dependency 'redcarpet', '~> 3.5', '>= 3.5.1'#, require: false + spec.add_development_dependency 'yard', '~> 0.9.26'#, require: false + spec.add_development_dependency 'rubocop', '~> 1.7' # For more information and examples about making a new gem, checkout our # guide at: https://bundler.io/guides/creating_gem.html diff --git a/lib/felflame/version.rb b/lib/felflame/version.rb index fc7d58b..ea5d4b6 100644 --- a/lib/felflame/version.rb +++ b/lib/felflame/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Felflame - VERSION = "1.0.0.beta1" + VERSION = "1.0.0" end |
