Skip to content

Commit c697f2b

Browse files
authored
Merge pull request #628 from srobo/no-simple
Remove or reword most references to "simple" tasks
2 parents 93a4c75 + a843857 commit c697f2b

File tree

9 files changed

+13
-14
lines changed

9 files changed

+13
-14
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The Student Robotics public documentation.
44

55
## Getting Started
66

7-
For ease of setup, a Docker container is provided. Simply install Docker and `docker-compose`, and run `docker compose up`.
7+
For ease of setup, a Docker container is provided. Install Docker and `docker-compose`, then run `docker compose up`.
88

99
Once setup, the site will be accessible on http://localhost:4000/docs/
1010

competitor_resources/pre_kickstart_activities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Pre-Kickstart Activities
55

66
# Pre-Kickstart Activities
77

8-
The pre-Kickstart activities are a new concept we are introducing for SR2025. They use our simulator for a set of activities intended to be completed between registration and Kickstart. These will teach some core concepts of robotics and introduce some simple sensors that teams could use on their physical robots.
8+
The pre-Kickstart activities are a new concept we are introducing for SR2025. They use our simulator for a set of activities intended to be completed between registration and Kickstart. These will teach some core concepts of robotics and introduce some basic sensors that teams could use on their physical robots.
99

1010
We recommend you work through them as a team, so you can learn from each other.
1111
If you have any issues, just ask us on [Discord](/docs/tutorials/discord).

programming/arduino/sr_firmware.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,11 @@ In this state, they might read high or low, or different values depending on the
123123
This is obviously not good for consistent control.
124124

125125
Many pieces of off-the-shelf electronics that have some form of standard I/O output will connect this pin to 5.0V (high) and 0V (low) when required, so this is not a problem.
126-
However, for simple electronics, a microswitch for example, you would normally be required to connect a resistor between the input pin and 5.0V (a pull-up resistor) to keep the input in a known state until the switch overrides it by connecting directly to 0V.
126+
However, for basic electronics, a microswitch for example, you would normally be required to connect a resistor between the input pin and 5.0V (a pull-up resistor) to keep the input in a known state until the switch overrides it by connecting directly to 0V.
127127

128128
However, the built-in pull-up resistor alleviates this need.
129129
It essentially wires in a resistor connected to 5.0V, meaning that when this option is enabled, an input pin will "default" to being high.
130-
This means you can simply connect a switch between the input pin and a ground pin without any need of resistors - when the switch is open, the pin will read high; when closed, it will read low.
130+
This means you can connect a switch between the input pin and a ground pin without any need of resistors - when the switch is open, the pin will read high; when closed, it will read low.
131131

132132
## Ultrasound Sensors
133133

programming/robot_api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: Robot API
1010
Student Robotics has written a module — `sr.robot3` — which is used to interface with the hardware.
1111
It handles all the low-level interactions so you don't have to.
1212

13-
For example, to set the power of output 0 on a Motor Board to 30%, you would simply write:
13+
For example, to set the power of output 0 on a Motor Board to 30%, you would write:
1414

1515
~~~~~ python
1616
robot.motor_board.motors[0].power = 0.3

robots_101/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The aim of this article is to give you a jumping off point rather than prescribe
1111

1212
Before settling on a final design, it’s a good idea to devise several different strategies. Making a scale plan or model of the arena, tokens, and robots is a very good way to start thinking about these and can aid discussion. Be sure to document the pros and cons of each strategy. Include point scoring, ease of implementation, additional items required to implement the strategy, and possible interactions with other robots.
1313

14-
Narrow the list and prototype some hardware (can be simple) to assess feasibility. The most complex, technologically advanced strategy is not necessarily the best. A simple (and elegant) strategy is more straightforward, quicker to implement and less likely to fail. On many occasions, a simple strategy has won the day.
14+
Narrow the list and prototype some hardware (can be basic) to assess feasibility. The most complex, technologically advanced strategy is not necessarily the best. A simple (and elegant) strategy is more straightforward, quicker to implement and less likely to fail. On many occasions, a simple strategy has won the day.
1515

1616
## Movement
1717

robots_101/programme_structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ before the start of the competition year.
2222

2323
We also provide some [pre-kickstart activities][pre-kickstart-activities] which
2424
teach some core concepts of robotics making use of our [simulator][simulator]
25-
and introduce some simple sensors that you could use on your physical robots.
25+
and introduce some basic sensors that you could use on your physical robots.
2626

2727
## Kickstart
2828

tutorials/getting_code_on_the_robot.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@ title: Getting Code on the Robot
1010
For your robot to function, it needs some code to tell it what to do.
1111
This code will be written on your computer, but then needs to be transferred to your robot to execute it.
1212

13-
Getting your code on to the robot is quite simple.
1413
You will need to put your code on a USB drive which will need to be formatted with either FAT32, exFAT or ext2/3/4.
1514
Upon plugging in the drive or starting up, the robot will run the `robot.py` file found in the root of the drive.
1615

17-
To re-run your program, simply remove the USB stick from the robot and plug it back in again and it will restart automatically.
16+
To re-run your program, remove the USB stick from the robot and plug it back in again and it will restart automatically.
1817

1918

2019
## Windows

tutorials/python.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ print("Number of bees:", y - 2)
5050

5151
The statements are executed one by one, in order. This example would give the output `Number of bees: 12`.
5252

53-
As you may have guessed, the `print(...)` statement displays text on the screen, while the other two lines are simple algebra.
53+
As you may have guessed, the `print(...)` statement displays text on the screen, while the other two lines are basic algebra.
5454

5555
### Strings
5656

@@ -85,7 +85,7 @@ This example would output `The answer is 42`, as the subtraction is not executed
8585

8686
Variables store values for later use, as in the first example. They can store many different things, but the most relevant here are numbers, strings (blocks of text), booleans (`True` or `False`) and lists (which we'll come to later).
8787

88-
To set a variable, simply give its name (see [Identifiers], below), followed by `=` and a value. For example:
88+
To set a variable, give its name (see [Identifiers], below), followed by `=` and a value. For example:
8989

9090
~~~~~ python
9191
x = 8
@@ -456,7 +456,7 @@ Try the same, but with the right angle in the top-right, like so (again, for inp
456456
[Calling functions](#calling-functions) {#calling-functions}
457457
-------------------
458458

459-
Functions are pre-written bits of code that can be run ('called') at any point. The simplest functions take no parameters and return nothing. For example, the `exit` function ends your program prematurely:
459+
Functions are pre-written bits of code that can be run ('called') at any point. The most basic functions take no parameters and return nothing. For example, the `exit` function ends your program prematurely:
460460

461461
~~~~~ python
462462
x = 10

tutorials/update_brain.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The below will automatically calculate the latest version number, to be used whe
1414
# Updating your brain board
1515

1616
The SD card is located on the underside of the board underneath the green power connector.
17-
Grab the SD card with your fingers and simply pull it out of the slot.
17+
Grab the SD card with your fingers and pull it out of the slot.
1818

1919
To fully update your Brain Board's software, or refresh it if you think it's not working correctly, you can flash our SD card image onto the microSD card in your Brain Board.
2020

@@ -25,7 +25,7 @@ The flashing procedure is identical to flashing Raspberry Pi images.
2525

2626
### Etcher
2727

28-
We recommend using [Etcher](https://etcher.io), as it's simple to use, and available on Windows, macOS and Linux.
28+
We recommend using [Etcher](https://etcher.io), as it's designed for people of all skill levels, and is available on Windows, macOS and Linux.
2929
If you're familiar with Raspberry Pis or other similar boards and have flashed images before with a different tool, that should also work.
3030

3131
![Etcher example]({{ site.baseurl }}/images/content/kit/etcher.png)

0 commit comments

Comments
 (0)