okfn-brasil / serenata-toolbox

📦 pip module containing code shared across Serenata de Amor's projects | ** Este repositório não recebe atualizações frequentes **
MIT License
154 stars 69 forks source link

Update README.rst #194

Closed willianpaixao closed 6 years ago

willianpaixao commented 6 years ago

What is the purpose of this Pull Request? To have a more detailed and updated documentation for contribution.

What was done to achieve this purpose? Change the README.rst file.

How to test if it really works? Copy the commands and run locally.

Who can help reviewing it? Downloading the code and building it locally, following the tutorial.

willianpaixao commented 6 years ago

I just would like to better explain the reason why I requested the change from pythonand pip to python3and pip3. As Python 3 isn't the default in almost all OSes, the user must explicitly install and change the default in order to call Python 3 under the command python. [1]

More advanced users when facing the errors for building the code under Python 2.x would quickly understand and correct the commands but would be nice to make easier to use the more compatible command in the documentation.

willianpaixao commented 6 years ago

@cuducos changes regarding Python 3 reverted.

But I changed the codeto code-block blocks and now we have language code highlighted. :)

cuducos commented 6 years ago

But I changed the code to code-block blocks and now we have language code highlighted. :)

Yay 🎉

willianpaixao commented 6 years ago

All changes made and commits squashed.