diff --git a/README.md b/README.md index a11afe08fa59e3f65e43bbc81d989a58dd680b15..2f281c583c2c2b5a5966899bea1ab17564b98698 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Place your app-specific code in app/ dir, and utility code that you'd like to ex * Clone the repo: `git clone https://github.com/artemv/ruby-starter-kit.git my-app` ## 1 - In your machine -* Install Ruby 2.4.1 from https://www.ruby-lang.org/en/downloads/ or via RVM (https://rvm.io/) +* Install Ruby 2.4.2 from https://www.ruby-lang.org/en/downloads/ or via RVM (https://rvm.io/) * Install Bundler and dependencies: ``` cd my-app @@ -24,23 +24,30 @@ gem install bundler bundle install ``` +Alternatively if you are using Yeoman you can install it using its generator as described [here](https://github.com/artemv/generator-ruby-starter-kit). + ## 2 - Using Docker * Build the Docker Compose: ``` docker-compose up --build ``` +If it complains like "ERROR: The Docker Engine version is less than the minimum required by Compose. Your current project requires a Docker Engine of version 1.13.0 or greater." +that means you have too old version of docker server. Check it with command: +`docker version`. Then you can upgrade it with `docker-machine upgrade default`. + * Go inside the docker container: ``` docker exec -it <docker-image> /bin/bash ``` -Alternatively if you are using Yeoman you can install it using its generator as described [here](https://github.com/artemv/generator-ruby-starter-kit). - +Now you can change the source files locally, and the changes will be seen inside docker container transparently - so +it's rather straightforward way to set up a working dev env. + # Usage Run the app entry point script: ``` -repo=octokit.py bin/app.rb +repo=octokit.rb bin/app.rb ``` Run the guard dev env tool: diff --git a/bin/app.rb b/bin/app.rb index e24bd49a214ab97015bf13b669f9fa05028437d1..fdd9b1888a4d4c0bb8e00207bfa9742455de2d85 100755 --- a/bin/app.rb +++ b/bin/app.rb @@ -1,6 +1,6 @@ #!/usr/bin/env ruby require_relative '../lib/environment' -raise 'Usage: repo=octokit.py bin/app.rb' unless ENV['repo'] +raise 'Usage: repo=octokit.rb bin/app.rb' unless ENV['repo'] puts Main.new(ENV['repo']).run