montrealrb/Montreal.rb

Make the project easier to install

Opened this issue · 1 comments

In the previous workshops, we had several people not knowing where to begin with. Ruby was not installed and they are making their first steps into Rails and open-source development.

We want to help them get started by having kickass docs.

We should include a step by step guide to installation (example: 1- check if you have the right ruby version installed, 2- install ruby (link to railsbridge docs), 3- etc.. etc.. etc...)

We should also include more detailed information about the pull-request process. What is a fork, how to keep your fork up to date, etc. I'm pretty sure there are guides that we can link to.

The main readme file should be reorganized to make it easier to find the information (the more important at the top)

What do you think about a develop in docker approach?