README.md in thinreports-0.12.1 vs README.md in thinreports-0.13.0

- old
+ new

@@ -7,13 +7,12 @@ ## Prerequisites ### Supported Versions -- Ruby 2.5, 2.6, 2.7, 3.0 -- JRuby 9.2 -- Prawn 2.2, 2.3, 2.4 +- Ruby 2.7, 3.0, 3.1, 3.2 +- Prawn 2.4+ ## Installation Add this line to your application's Gemfile: @@ -38,11 +37,11 @@ See [the README](https://github.com/thinreports/thinreports) for usage of the Section Format. ### Basic Format -The template file (`.tlf`) must be created in [the Basic Editor of the Thinreports Editor](https://github.com/thinreports/thinreports-editor/tree/master/basic-editor). +The template file (`.tlf`) must be created in the [Thinreports Basic Editor](https://github.com/thinreports/thinreports-basic-editor/). ```ruby require 'thinreports' report = Thinreports::Report.new layout: 'report.tlf' @@ -163,11 +162,11 @@ report.on_page_create do |page| page.item(:text).value('Text for all pages') end ``` -See also [features/report_callbacks](https://github.com/thinreports/thinreports-generator/tree/master/test/features/report_callbacks). +See also [basic_report/features/report_callbacks](https://github.com/thinreports/thinreports-generator/tree/main/test/basic_report/features/report_callbacks). #### List ```ruby report = Thinreports::Report.new layout: 'list.tlf' @@ -212,11 +211,11 @@ price_per_page += price end end ``` -See also [features/list_events](https://github.com/thinreports/thinreports-generator/tree/master/test/features/list_events). +See also [basic_report/features/list_events](https://github.com/thinreports/thinreports-generator/tree/main/test/basic_report/features/list_events). #### Page Number ```ruby # Setting starting number of page @@ -233,11 +232,11 @@ page.item(:pageno).visible(false) page.item(:pageno).styles(color: 'red', bold: true) end ``` -See also [features/page_number](https://github.com/thinreports/thinreports-generator/blob/master/test/features/page_number) and [features/page_number_with_list](https://github.com/thinreports/thinreports-generator/blob/master/test/features/page_number_with_list). +See also [basic_report/features/page_number](https://github.com/thinreports/thinreports-generator/blob/main/test/basic_report/features/page_number) and [basic_report/features/page_number_with_list](https://github.com/thinreports/thinreports-generator/blob/main/test/basic_report/features/page_number_with_list). #### Configuring fallback fonts ```ruby Thinreports.configure do |config| @@ -245,26 +244,22 @@ end Thinreports.config.fallback_fonts = ['/path/to/font_a.ttf', '/path/to/font_b.ttf'] ``` -See also [features/eudc](https://github.com/thinreports/thinreports-generator/blob/master/test/features/eudc). +See also [basic_report/features/eudc](https://github.com/thinreports/thinreports-generator/blob/main/test/basic_report/features/eudc). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/thinreports/thinreports-generator. 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/thinreports/thinreports/blob/master/CODE_OF_CONDUCT.md). +Bug reports and pull requests are welcome on GitHub at https://github.com/thinreports/thinreports-generator. 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/thinreports/thinreports/blob/main/CODE_OF_CONDUCT.md). ## Development -### How to run feature tests +### Feature test requires diff-pdf command -``` -$ bundle exec rake test:features -``` +In order to run feature test, you need to install [diff-pdf](https://github.com/vslavik/diff-pdf) in your environment, or you can run test in the docker container as below. -In order to run `test:features`, you need to install [diff-pdf](https://github.com/vslavik/diff-pdf) in your environment, or you can run test in the docker container as below. - ### How to develop in Docker container You can use the Docker container for development. This container contains the libraries required for testing, such as diff-pdf. ``` @@ -276,19 +271,19 @@ You can run test: ``` > /src# bundle install -> /src# bundle exec rake test:features +> /src# bundle exec rake test ``` ## Releasing Generator 1. Update the version number in `version.rb` 2. Update `CHANGELOG.md` and `README.md` (if needed) 3. Create the Release PR like #105 4. Merge the PR -5. Is the master CI green? If not, make it green +5. Is the main CI green? If not, make it green 6. 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 ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).