README.md in openstudio-extension-0.2.0 vs README.md in openstudio-extension-0.2.1

- old
+ new

@@ -29,31 +29,31 @@ | module OpenStudio module ModelArticulation class ModelArticulation < OpenStudio::Extension::Extension | module BuildingSync class BuildingSync < OpenStudio::Extension::Extension | ## Installation -To use this and other extension gems, you will need Ruby 2.2.4 and OpenStudio 2.7.1 or greater. +To use this and other extension gems, you will need Ruby 2.5.x and OpenStudio 3.0.0 or greater. ### Windows Installation -Install Ruby using the [RubyInstaller](https://rubyinstaller.org/downloads/archives/) for [Ruby 2.2.4 (x64)](https://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.2.4-x64.exe). +Install Ruby using the [RubyInstaller](https://rubyinstaller.org/downloads/archives/) for [Ruby 2.5.5 (x64)](https://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.5.5-x64.exe). Install Devkit using the [mingw64](https://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe) installer. -Check the ruby installation returns the correct Ruby version (2.2.4): +Check the ruby installation returns the correct Ruby version (2.5.x): ``` ruby -v ``` Install bundler from the command line ``` -gem install bundler -v 1.17 +gem install bundler -v 2.1 ``` -Install OpenStudio. Create a file ```C:\ruby-2.2.4-x64-mingw32\lib\ruby\site_ruby\openstudio.rb``` and point it to your OpenStudio installation by editing the contents. E.g.: +Install OpenStudio. Create a file ```C:\ruby-2.5.5-x64-mingw32\lib\ruby\site_ruby\openstudio.rb``` and point it to your OpenStudio installation by editing the contents. E.g.: ```ruby -require 'C:\openstudio-2.7.1\Ruby\openstudio.rb' +require 'C:\openstudio-3.0.0\Ruby\openstudio.rb' ``` Verify your OpenStudio and Ruby configuration: ``` ruby -e "require 'openstudio'" -e "puts OpenStudio::Model::Model.new" @@ -63,23 +63,24 @@ It is recommended that you install [rbenv](https://github.com/rbenv/rbenv) to easily manage difference versions of Ruby. rbenv can be installed via [Homebrew](https://brew.sh/): ``` brew install rbenv rbenv init -rbenv install 2.2.4 +rbenv install 2.5.5 ``` Also install bundler ``` -gem install bundler -v 1.17 +gem install bundler -v 2.1 ``` Install [OpenStudio](https://www.openstudio.net/downloads). -Add the RUBYLIB environment variable to your `bash_profile` (or similar) file. It should point to the Ruby folder within the OpenStudio Application you just downloaded (replace 2.7.2 with the version you are using): +Add the RUBYLIB environment variable to your `bash_profile` (or similar) file. It should point to the Ruby folder within +the OpenStudio Application you just downloaded (replace 3.0.0 with the version you are using): ``` -export RUBYLIB=/Applications/OpenStudio-2.7.2/Ruby +export RUBYLIB=/Applications/OpenStudio-3.0.0/Ruby ``` ## Contents The OpenStudio Extension Gem (this repo) contains methods that can be shared across and extended by other derivative extension gems. @@ -148,11 +149,11 @@ | openstudio:list_measures | List all measures in the calling gem | | openstudio:measures:add_license | Add License File to measures in the calling gem | | openstudio:measures:add_readme | Add README.md.erb file if it and the README markdown file do not already exist for a measure | | openstudio:measures:copy_resources | Copy the resources files to individual measures in the calling gem | | openstudio:measures:update_copyright | Update copyright on measure files in the calling gem | -| openstudio`:runner:`init | Create a runner.conf file running simulations | +| openstudio`:runner:`init | Create a runner.conf file running simulations | | openstudio:stage_bcl | Copy the measures to a location that can be uploaded to BCL | | openstudio:push_bcl | Upload measures from the specified location to the BCL | | openstudio:test_with_docker | Use openstudio docker image to run tests | | openstudio:test_with_openstudio | Use openstudio system ruby to run tests | | openstudio:update_measures | Run the CLI task to check for measure updates and update the measure xml files | @@ -233,24 +234,12 @@ * Locally - from the master branch, run `rake release` * On GitHub, go to the releases page and update the latest release tag. Name it “Version x.y.z” and copy the CHANGELOG entry into the description box. # TODO -- [X] Finalize documentation on naming conventions, etc -- [X] Add test measure -- [X] Rake task ```openstudio:update_measures``` -- [X] Rake task ```openstudio:test_with_openstudio``` - [ ] Rake task ```stage_bcl``` _DLM: BCL gem should be a development dependency only until we can reduce its dependencies and remove native dependencies? should probably put it into a special group so we can bundle without it in openstudio-gems._ - [ ] Rake task ```push_bcl``` _DLM: how do we want to test this? -- [X] Get all rake tasks working on Travis - [ ] Capture useful output from Travis (measure dashboard results, log files, zip of build products, etc) and put it somewhere (s3? naming convention?) -- [X] ```Extension::openstudio_extension_version``` _DLM: should we rename? should people overwrite this in their class?_ -- [X] ```Extension::measures_dir``` _DLM: I think this can have a default implementation, right? If something does not need to be overridden should it be a module method rather than a class one? KAF: this is in rake task for now -- [X] ```Extension::list_measures``` _DLM: I think this can have a default implementation, right?_KAF: In Rake task for now - [ ] ```Extension::files_dir``` _DLM: I think this can have a default implementation, right?_ - [ ] ```Extension::minimum_openstudio_version``` _DLM: should we rename? should people overwrite this in their class?_ -- [X] ```Runner::initialize``` _DLM: should say that the path argument should be for a dir with a Gemfile right?_ -- [X] ```Runner::configure_osw``` _DLM: should take in an OSW, add paths to all measure and file dirs for loaded OpenStudio Extensions, write out configured OSW_ -- [ ] Run rubocop on all of the core files and remove exclusion from .rubocop.yml file. - [ ] Cleanup task after running tests (may need to be in the OpenStudio Measure Tester) -- [X] Add a `rake init new_ext_gem` to Rakefile - [ ] Add tests to the extension/core