Skip to content

Commit 8ac64fc

Browse files
authored
SR2024 - Update Section - Programming
2 parents fa122a7 + 1bbabbe commit 8ac64fc

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

programming/index.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,36 @@ layout: page
33
title: Programming
44
---
55

6-
Programming Your Robot
7-
======================
6+
# Programming Your Robot
87

9-
<!-- Robots that are made using the SR kit are programmed with [Python](/docs/programming/python/) which is made possible with a custom-built Python library, `sr.robot3`; see [here](/docs/programming/robot_api/) for more details. The pages under this section should contain all of the information you need to know to successfully code for your robot.
8+
Robots build using the SR kit are programmed with [Python 3.11](https://www.python.org) which is made possible with a custom-built Python library, `sr.robot3`.
9+
This library deals with talking to the boards and doing all the complicated bits so you can focus on the fun bits.
1010

11-
* In order to develop the code for your robot, we recommend that you use a code
12-
editor. For more information about this, including some suggestions for
13-
suitable editors, see the [Code Editors](/docs/programming/editors/) section.
11+
The [Robot API]({{ site.baseurl }}/programming/robot_api/) page has the details about this library.
12+
The other pages in this section contain all of the information you need to know to successfully code for your robot.
1413

15-
* Under the [Python](/docs/programming/python/) section, some of the more intricate features of Python are explained in sufficient detail to program a robot. Links to tutorials are also provided to introduce a new programmer to Python.
1614

17-
* Under the [sr](/docs/programming/sr/) section is an API reference for the Student Robotics module, used to interface with the hardware. -->
15+
## Learning python
1816

19-
20-
<!--
21-
TODO - below is from python page
22-
23-
Student Robotics robots are all programmed in [Python 3.10](https://www.python.org);
24-
to program a robot, it is important that you have a basic understanding of Python.
17+
Your robot is programmed in [Python](https://www.python.org), so to make your robot do things you will need at least a basic understanding of Python.
2518

2619
There are a number of tutorials out there which might help you to learn to program in Python:
2720

2821
* [Our tutorial](/docs/tutorials/python), called _Python: A whirlwind tour_.
29-
This was written especially for Student Robotics competitors,
30-
and explains the basics while trying not to overwhelm you.
22+
This was written especially for Student Robotics competitors, and explains the basics while trying not to overwhelm you.
23+
24+
* [The Official Tutorial](https://docs.python.org/3.10/tutorial/) -- The tutorial provided by the people who make Python.
25+
Most of the useful stuff starts at chapter 3, but you should at least skim the stuff before it; there is a lot there and it may be a little overwhelming.
26+
27+
* A number of beginners tutorials are linked to from the [python wiki](https://wiki.python.org/moin/BeginnersGuide/NonProgrammers).
28+
One of these that we would suggest is the [Wikibooks Tutorial](https://en.wikibooks.org/wiki/Non-Programmer%27s_Tutorial_for_Python_3).
29+
30+
* [The Official Python Docs](https://docs.python.org/3.11/) contains every piece of information about the core language that you would need.
31+
The format isn't that digestible, use it as a reference and use the search to find a specific section that you need.
3132

32-
* [The Official Tutorial](https://docs.python.org/3.10/tutorial/) -- the good stuff starts at chapter 3,
33-
but you should at least skim the stuff before it;
34-
there is a lot there and it may be a little overwhelming.
3533

36-
* A number of tutorials for beginners are linked to from [here](https://wiki.python.org/moin/BeginnersGuide/NonProgrammers).
37-
[Wikibooks Tutorial](https://en.wikibooks.org/wiki/Non-Programmer%27s_Tutorial_for_Python_3) seems like a good one.
34+
## Writing code
3835

39-
* [The Official Docs](https://docs.python.org/3.10/), for the version of python on the [Brain Board](/docs/kit/brain_board). -->
36+
In order to develop the code for your robot, we recommend that you use a code editor.
37+
A good code editor can provide you with features such as auto completion and syntax highlighting which will help you more easily write code.
38+
For suggestions of suitable editors, and how to set them up see the [Code Editors]({{ site.baseurl }}/tutorials/editors/) section.

0 commit comments

Comments
 (0)