From da63aca530696f051f0d9d107764db3779839864 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Wed, 6 Dec 2017 20:29:32 +0000 Subject: [PATCH 01/12] Add some recommended editors --- .spelling | 2 ++ content/tutorials/editors.md | 20 ++++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 content/tutorials/editors.md diff --git a/.spelling b/.spelling index 41dd9d6d..e95385b0 100644 --- a/.spelling +++ b/.spelling @@ -26,3 +26,5 @@ square-ish 83x99x24mm 4mm 2.2A. +PyCharm +macOS diff --git a/content/tutorials/editors.md b/content/tutorials/editors.md new file mode 100644 index 00000000..afa412fc --- /dev/null +++ b/content/tutorials/editors.md @@ -0,0 +1,20 @@ +--- +title: Recommended Editors +--- + +To edit your code, you'll need an editor. + +{{% notice info %}} +To write code for the kit, you don't need anything specific in your editor, you just need to be able to edit Python (`.py` files), and get them onto a USB drive. +{{% /notice %}} + +Any editor will do, so it's recommended to use one you're already familiar with. If you don't already have a preference, here's some great ones, available on Windows, macOS, and Linux! + +- [Sublime Text 3](https://sublimetext.com) +- [Visual Studio Code](https://code.visualstudio.com) +- [PyCharm](https://jetbrains.com/pycharm/) +- [Atom](https://atom.io/) +- [IDLE](https://wiki.python.org/moin/IDLE) (comes with Python!) + + + From b8154a0cdd85c4534f5046967a55c9150e6d7312 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Wed, 6 Dec 2017 20:51:34 +0000 Subject: [PATCH 02/12] Add documentation on installing type definitions --- content/api/local-installation.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 content/api/local-installation.md diff --git a/content/api/local-installation.md b/content/api/local-installation.md new file mode 100644 index 00000000..34094f41 --- /dev/null +++ b/content/api/local-installation.md @@ -0,0 +1,31 @@ +--- +title: Local installation +--- + +Installing our code locally will allow your editor you extract type definitions from the `Robot` class and its boards, as well as allowing type completion on parameters. + +Installing these definitions is highly optional, however will be incredibly useful if your editor supports this. All editors in our [recommended list](/tutorials/editors/) besides IDLE will support it. + +## Installation +Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. On Windows, this is best done using the [`get-pip.py` script](https://pip.pypa.io/en/stable/installing). + +```bash +pip install git+https://github.com/sourcebots/robot-api +``` + +If you're doing this on a shared computer, such as those found in your colleges, add `--user` to the end: + +```bash +pip install git+https://github.com/sourcebots/robot-api --user +``` + +Simply restart your editor of choice, and it should these up and start being able to use them immediately. + +## Upgrading installation + +When we release new updates, you'll need to update the locally installed version too, so you have the most up to date definitions. To do this, simply repeat the previous command, with `--update`: + +```bash +pip install git+https://github.com/sourcebots/robot-api --update +pip install git+https://github.com/sourcebots/robot-api --user --update +``` \ No newline at end of file From d5eac82b3f769aa1cac34e29990c2a9a8ea63fb5 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Thu, 7 Dec 2017 10:12:15 +0000 Subject: [PATCH 03/12] Cleanup editors file --- content/tutorials/editors.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/content/tutorials/editors.md b/content/tutorials/editors.md index afa412fc..97829ec9 100644 --- a/content/tutorials/editors.md +++ b/content/tutorials/editors.md @@ -5,7 +5,7 @@ title: Recommended Editors To edit your code, you'll need an editor. {{% notice info %}} -To write code for the kit, you don't need anything specific in your editor, you just need to be able to edit Python (`.py` files), and get them onto a USB drive. +To write code for the kit, you don't need anything specific in your editor, you just need to be able to edit Python (`.py`) files, and get them onto a USB drive. {{% /notice %}} Any editor will do, so it's recommended to use one you're already familiar with. If you don't already have a preference, here's some great ones, available on Windows, macOS, and Linux! @@ -15,6 +15,3 @@ Any editor will do, so it's recommended to use one you're already familiar with. - [PyCharm](https://jetbrains.com/pycharm/) - [Atom](https://atom.io/) - [IDLE](https://wiki.python.org/moin/IDLE) (comes with Python!) - - - From 4c2306ba14d5ad9923ab2856f27c548737327155 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Thu, 7 Dec 2017 19:10:15 +0000 Subject: [PATCH 04/12] Update grammar from review --- .spelling | 1 + content/api/local-installation.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.spelling b/.spelling index e95385b0..c7dc8aa9 100644 --- a/.spelling +++ b/.spelling @@ -28,3 +28,4 @@ square-ish 2.2A. PyCharm macOS +IntelliSense \ No newline at end of file diff --git a/content/api/local-installation.md b/content/api/local-installation.md index 34094f41..819629c2 100644 --- a/content/api/local-installation.md +++ b/content/api/local-installation.md @@ -2,7 +2,7 @@ title: Local installation --- -Installing our code locally will allow your editor you extract type definitions from the `Robot` class and its boards, as well as allowing type completion on parameters. +Installing our code locally will allow your editor you to extract type definitions from the `Robot` class and its boards, as well as allowing auto-complete (also known as [IntelliSense](https://en.wikipedia.org/wiki/IntelliSense)). Installing these definitions is highly optional, however will be incredibly useful if your editor supports this. All editors in our [recommended list](/tutorials/editors/) besides IDLE will support it. @@ -19,7 +19,7 @@ If you're doing this on a shared computer, such as those found in your colleges, pip install git+https://github.com/sourcebots/robot-api --user ``` -Simply restart your editor of choice, and it should these up and start being able to use them immediately. +Simply restart your editor of choice, and it should detect and start being able to use them immediately. ## Upgrading installation From 73871e3e0b723e045bcef4de1ecdcc2167b3f430 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Thu, 7 Dec 2017 19:18:17 +0000 Subject: [PATCH 05/12] Remove unnecessary 'you' --- content/api/local-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/api/local-installation.md b/content/api/local-installation.md index 819629c2..e0ff6856 100644 --- a/content/api/local-installation.md +++ b/content/api/local-installation.md @@ -2,7 +2,7 @@ title: Local installation --- -Installing our code locally will allow your editor you to extract type definitions from the `Robot` class and its boards, as well as allowing auto-complete (also known as [IntelliSense](https://en.wikipedia.org/wiki/IntelliSense)). +Installing our code locally will allow your editor to extract type definitions from the `Robot` class and its boards, as well as allowing auto-complete (also known as [IntelliSense](https://en.wikipedia.org/wiki/IntelliSense)). Installing these definitions is highly optional, however will be incredibly useful if your editor supports this. All editors in our [recommended list](/tutorials/editors/) besides IDLE will support it. From 96a0bfe71c0f73d563cf64daf14dc57e8c1eed0b Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Fri, 8 Dec 2017 18:54:47 +0000 Subject: [PATCH 06/12] Cleanup and simplification of editor recommendation --- content/api/{local-installation.md => editor-support.md} | 8 ++++---- content/tutorials/editors.md | 7 ++++--- 2 files changed, 8 insertions(+), 7 deletions(-) rename content/api/{local-installation.md => editor-support.md} (62%) diff --git a/content/api/local-installation.md b/content/api/editor-support.md similarity index 62% rename from content/api/local-installation.md rename to content/api/editor-support.md index e0ff6856..72a698a3 100644 --- a/content/api/local-installation.md +++ b/content/api/editor-support.md @@ -1,13 +1,13 @@ --- -title: Local installation +title: Editor support --- -Installing our code locally will allow your editor to extract type definitions from the `Robot` class and its boards, as well as allowing auto-complete (also known as [IntelliSense](https://en.wikipedia.org/wiki/IntelliSense)). +Installing our code locally will allow your editor to extract information from our code, giving you additional features like auto-complete (also known as [IntelliSense](https://en.wikipedia.org/wiki/IntelliSense)). -Installing these definitions is highly optional, however will be incredibly useful if your editor supports this. All editors in our [recommended list](/tutorials/editors/) besides IDLE will support it. +Installing these definitions is optional, however will be incredibly useful if your editor supports this. All editors in our [recommended list](/tutorials/editors/) besides IDLE will support it. ## Installation -Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. On Windows, this is best done using the [`get-pip.py` script](https://pip.pypa.io/en/stable/installing). +Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. ```bash pip install git+https://github.com/sourcebots/robot-api diff --git a/content/tutorials/editors.md b/content/tutorials/editors.md index 97829ec9..77667ec9 100644 --- a/content/tutorials/editors.md +++ b/content/tutorials/editors.md @@ -5,13 +5,14 @@ title: Recommended Editors To edit your code, you'll need an editor. {{% notice info %}} -To write code for the kit, you don't need anything specific in your editor, you just need to be able to edit Python (`.py`) files, and get them onto a USB drive. +To write code for the kit, you don't need anything specific in your editor, you just need to be able to edit Python (`.py`) text files, and get them onto a USB drive. {{% /notice %}} Any editor will do, so it's recommended to use one you're already familiar with. If you don't already have a preference, here's some great ones, available on Windows, macOS, and Linux! -- [Sublime Text 3](https://sublimetext.com) - [Visual Studio Code](https://code.visualstudio.com) - [PyCharm](https://jetbrains.com/pycharm/) - [Atom](https://atom.io/) -- [IDLE](https://wiki.python.org/moin/IDLE) (comes with Python!) +- [Sublime Text 3](https://sublimetext.com) (License recommended for continued use) +- [Notepad++](https://notepad-plus-plus.org/) (Windows only) +- [IDLE](https://wiki.python.org/moin/IDLE) (Pre-installed with Python on Windows!) From 176df7fe0ffc6f2bc78ca2582a65747406e3e7a6 Mon Sep 17 00:00:00 2001 From: Henry Oliver Edwards <32649829+BitBait@users.noreply.github.com> Date: Sat, 9 Dec 2017 17:52:42 +0000 Subject: [PATCH 07/12] ADded windows instruction Added commands for powershell using py -m for all bash commands --- content/api/editor-support.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/content/api/editor-support.md b/content/api/editor-support.md index 72a698a3..9e9583f9 100644 --- a/content/api/editor-support.md +++ b/content/api/editor-support.md @@ -7,17 +7,27 @@ Installing our code locally will allow your editor to extract information from o Installing these definitions is optional, however will be incredibly useful if your editor supports this. All editors in our [recommended list](/tutorials/editors/) besides IDLE will support it. ## Installation -Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. +Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. ```bash pip install git+https://github.com/sourcebots/robot-api ``` +And on windows: + +```powershell +py -m pip install git+https://github.com/sourcebots/robot-api +``` If you're doing this on a shared computer, such as those found in your colleges, add `--user` to the end: ```bash pip install git+https://github.com/sourcebots/robot-api --user ``` +And on windows: + +```powershell +py -m pip install git+https://github.com/sourcebots/robot-api --user +``` Simply restart your editor of choice, and it should detect and start being able to use them immediately. @@ -28,4 +38,10 @@ When we release new updates, you'll need to update the locally installed version ```bash pip install git+https://github.com/sourcebots/robot-api --update pip install git+https://github.com/sourcebots/robot-api --user --update -``` \ No newline at end of file +``` +And on windows: + +```powershell +py -m pip install git+https://github.com/sourcebots/robot-api --update +py -m pip install git+https://github.com/sourcebots/robot-api --user --update +``` From 6cad438bae197b34453f8f0472d3758ab40d9dad Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Fri, 15 Dec 2017 22:37:36 +0000 Subject: [PATCH 08/12] Dont assume the college need --user --- content/api/editor-support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/api/editor-support.md b/content/api/editor-support.md index 9e9583f9..314ac0c0 100644 --- a/content/api/editor-support.md +++ b/content/api/editor-support.md @@ -18,7 +18,7 @@ And on windows: py -m pip install git+https://github.com/sourcebots/robot-api ``` -If you're doing this on a shared computer, such as those found in your colleges, add `--user` to the end: +If you're doing this on a shared computer, such as those you may find in your colleges, add `--user` to the end: ```bash pip install git+https://github.com/sourcebots/robot-api --user From 8e8df07b1e225cffdde56aa4974e206ab01b2569 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Sat, 16 Dec 2017 09:16:01 +0000 Subject: [PATCH 09/12] Windows isnt a special little fruit like we thought --- content/api/editor-support.md | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/content/api/editor-support.md b/content/api/editor-support.md index 314ac0c0..4bb89904 100644 --- a/content/api/editor-support.md +++ b/content/api/editor-support.md @@ -7,27 +7,17 @@ Installing our code locally will allow your editor to extract information from o Installing these definitions is optional, however will be incredibly useful if your editor supports this. All editors in our [recommended list](/tutorials/editors/) besides IDLE will support it. ## Installation -Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. +Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. ```bash pip install git+https://github.com/sourcebots/robot-api ``` -And on windows: - -```powershell -py -m pip install git+https://github.com/sourcebots/robot-api -``` If you're doing this on a shared computer, such as those you may find in your colleges, add `--user` to the end: ```bash pip install git+https://github.com/sourcebots/robot-api --user ``` -And on windows: - -```powershell -py -m pip install git+https://github.com/sourcebots/robot-api --user -``` Simply restart your editor of choice, and it should detect and start being able to use them immediately. @@ -39,9 +29,3 @@ When we release new updates, you'll need to update the locally installed version pip install git+https://github.com/sourcebots/robot-api --update pip install git+https://github.com/sourcebots/robot-api --user --update ``` -And on windows: - -```powershell -py -m pip install git+https://github.com/sourcebots/robot-api --update -py -m pip install git+https://github.com/sourcebots/robot-api --user --update -``` From 1186db5ae4b65d58e98b80ada38c86df967f3529 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Sat, 16 Dec 2017 09:20:15 +0000 Subject: [PATCH 10/12] windows is kinda special --- content/api/editor-support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/api/editor-support.md b/content/api/editor-support.md index 4bb89904..15417db5 100644 --- a/content/api/editor-support.md +++ b/content/api/editor-support.md @@ -7,7 +7,7 @@ Installing our code locally will allow your editor to extract information from o Installing these definitions is optional, however will be incredibly useful if your editor supports this. All editors in our [recommended list](/tutorials/editors/) besides IDLE will support it. ## Installation -Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. +Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. See [here](https://stackoverflow.com/a/12476379) for installation on windows. ```bash pip install git+https://github.com/sourcebots/robot-api From 04c557ed8db0cadadc5ab402ce981596ee084d11 Mon Sep 17 00:00:00 2001 From: James Seden Smith Date: Sat, 16 Dec 2017 09:24:32 +0000 Subject: [PATCH 11/12] Reword Windows specific part --- content/api/editor-support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/api/editor-support.md b/content/api/editor-support.md index 15417db5..e9b9fea7 100644 --- a/content/api/editor-support.md +++ b/content/api/editor-support.md @@ -7,7 +7,7 @@ Installing our code locally will allow your editor to extract information from o Installing these definitions is optional, however will be incredibly useful if your editor supports this. All editors in our [recommended list](/tutorials/editors/) besides IDLE will support it. ## Installation -Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. See [here](https://stackoverflow.com/a/12476379) for installation on windows. +Installing our API, the code you interact with, can be installed using `pip`, Python's built-in package manager. `pip` should be installed on your machine, if it's not, you'll need to look up how to install it. See [here](https://stackoverflow.com/a/12476379) for troubleshooting on Windows. ```bash pip install git+https://github.com/sourcebots/robot-api From 017ab52ac78b10a4e3e03548ef2ebe520f9b9b70 Mon Sep 17 00:00:00 2001 From: James Seden Smith Date: Sat, 16 Dec 2017 09:42:56 +0000 Subject: [PATCH 12/12] I totally didn't screw up that merge conflict --- .spelling | 1 + 1 file changed, 1 insertion(+) diff --git a/.spelling b/.spelling index 2d52e285..e0af5721 100644 --- a/.spelling +++ b/.spelling @@ -37,3 +37,4 @@ piezo 3m 2.2Ah iMAX +3mm