Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ square-ish
83x99x24mm
4mm
2.2A.
PyCharm
macOS
IntelliSense
numpy
scipy
piezo
Expand Down
31 changes: 31 additions & 0 deletions content/api/editor-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Editor support
---

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 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 troubleshooting on Windows.

```bash
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
```

Simply restart your editor of choice, and it should detect 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
```
18 changes: 18 additions & 0 deletions content/tutorials/editors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
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`) 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!

- [Visual Studio Code](https://code.visualstudio.com)
- [PyCharm](https://jetbrains.com/pycharm/)
- [Atom](https://atom.io/)
- [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!)