From 113ac32e7ca4386d42e05caa005c897d676f18e4 Mon Sep 17 00:00:00 2001 From: Guille Date: Fri, 26 Jun 2020 11:15:35 -0400 Subject: [PATCH 1/2] Update 'WINDOWS_INSTALL.md' --- WINDOWS_INSTALL.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/WINDOWS_INSTALL.md b/WINDOWS_INSTALL.md index cae47d43..78c43400 100644 --- a/WINDOWS_INSTALL.md +++ b/WINDOWS_INSTALL.md @@ -1,3 +1,10 @@ +# Prepare your environment. + +Download the latest version of python and Mycrosoft c++ redistributable + +* [Microsoft C++ redistributable](https://www.microsoft.com/en-ca/download/details.aspx?id=48145) +* [Python environment](https://www.python.org/downloads/) + # Get the code. 1. First thing you will need is an editor for your source code, that's a personal choice, but we would like to recomend PyCharm community edition, a wonderful open source python editor From ad3c48696a8894d0fd94b7702a0198388016bd01 Mon Sep 17 00:00:00 2001 From: Guille Date: Fri, 26 Jun 2020 11:23:41 -0400 Subject: [PATCH 2/2] Update 'WINDOWS_INSTALL.md' Grammar review and typo correction --- WINDOWS_INSTALL.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/WINDOWS_INSTALL.md b/WINDOWS_INSTALL.md index 78c43400..4391a1da 100644 --- a/WINDOWS_INSTALL.md +++ b/WINDOWS_INSTALL.md @@ -1,29 +1,29 @@ # Prepare your environment. -Download the latest version of python and Mycrosoft c++ redistributable +Download the latest version of python and Microsoft c++ redistributable * [Microsoft C++ redistributable](https://www.microsoft.com/en-ca/download/details.aspx?id=48145) * [Python environment](https://www.python.org/downloads/) # Get the code. -1. First thing you will need is an editor for your source code, that's a personal choice, but we would like to recomend PyCharm community edition, a wonderful open source python editor +1. First thing you will need is an editor for your source code, that's a personal choice, but we would like to recommend PyCharm community edition, an excellent open-source python editor. [PyCharm Community edition](https://www.jetbrains.com/pycharm/download/download-thanks.html?platform=windows&code=PCC) -2. Run the installer, and follow the instalation instructions for PyCharm, you may change a few options, but the default ones, should be fine. +2. Run the installer, and follow the installation instructions for PyCharm, you may change a few options, but the default ones should be fine. -3. Open pycharm and click on **"Get from Version Control"**. +3. Open PyCharm and click on **"Get from Version Control"**. ![pycharm wellcome screen](./docs/img/img_0.png) -4. Select Git as the version control and set the url to [libs repository](https://binarycat.org/git/Guille/libs.git) as shown in the picture. +4. Select Git as the version control and set the URL to [libs repository](https://binarycat.org/git/Guille/libs.git) as shown in the picture. ![pycharm get from version control screen](./docs/img/img_1.png) -You may need to install git, by clicking at ***Download and install*** +You may need to install Git, by clicking at ***Download and install***. 5. Click Clone to download CERC libs source code. @@ -34,26 +34,25 @@ you will end with a project like this. # Configure PyCharm. -We use 2 spaces as a tab instead standard [pep8](https://www.python.org/dev/peps/pep-0008/) 4 spaces indentation. - -this option could be configured in PyCharm at the settings screen as shown in the picture. +We use two spaces as a tab instead of standard [pep8](https://www.python.org/dev/peps/pep-0008/) four spaces indentation. +This option could be configured in PyCharm at the settings screen, as shown in the picture. ![pycharm configuration screen](./docs/img/img_5.png) -# Start your own project. +# Start your project. -1. Click on file new project like in the image +1. Click on file new project like in the image. ![pycharm new project screen](./docs/img/img_3.png) -2. Go to project settings and add the libs project to your own as shown in the picture +2. Go to project settings and add the libs project to your own, as shown in the picture. ![pycharm new project screen](./docs/img/img_4.png) -3. Add your first file to your project and click in install requirements to automatically download all the dependencies +3. Add your first file to your project and click in install requirements to automatically download all the dependencies. -4. When all the dependencies are satistied, we are good to go to start importing our first model. +4. When all the dependencies are satisfied, we are good to go to start importing our first model. by adding the following code to our main.py