Skip to content

Commit 4cce8bd

Browse files
committed
Add LICENSE; tidy up README
1 parent ee2bc59 commit 4cce8bd

File tree

2 files changed

+42
-5
lines changed

2 files changed

+42
-5
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Team Optimal
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
1-
This repository contains code for the robot controller, it should be added as a submodule to the [main Webots project repository](https://github.com/IDP-L211/idp).
1+
# Team Optimal Robot Controller
22

3-
Extensive inheritance from the provided `controller` module (a C interface) will be required, so it is useful to set up a proper development environment (consider using a virtual environment and an IDE) and set the robot controller to `<extern>` in Webots. More information at https://cyberbotics.com/doc/guide/using-your-ide?tab-language=python. The main steps for PyCharm are:
3+
This repository contains code for the robot controller, it should be added as a
4+
submodule to the [main Webots project
5+
repository](https://github.com/IDP-L211/idp).
6+
7+
## Development
8+
9+
It is useful to set up a proper development environment with the provided
10+
`controller` module (a C interface) included in your linter/IDE and set the
11+
robot controller to `<extern>` in Webots for debugging. More information at
12+
https://cyberbotics.com/doc/guide/using-your-ide?tab-language=python. The main
13+
steps for PyCharm are:
414

515
1. Configure the virtual environment in _Project Interpreter_
6-
2. Add the correct Webots `controller` directory (depending on your system and Python configuration, `controller/_controller.so` is slightly different) as _Content Root_ under _Project Structure_
7-
3. Create a _Run/Debug Configuration_, setting the [relevant environment variables](https://cyberbotics.com/doc/guide/running-extern-robot-controllers?tab-language=python)
16+
2. Add the correct Webots `controller` directory (depending on your system and
17+
Python configuration, `controller/_controller.so` is slightly different) as
18+
_Content Root_ under _Project Structure_
19+
3. Create a _Run/Debug Configuration_, setting the [relevant environment
20+
variables](https://cyberbotics.com/doc/guide/running-extern-robot-controllers?tab-language=python)
821

9-
If you still prefer to use the system Python or run controller directly from Webots, have a look at https://cyberbotics.com/doc/guide/using-python. This is especially important for people using MacOS and Homebrew, you may need to set the full path to your Python interpreter (get it by `which python3`).
22+
If you prefer to run controller directly from Webots, have a look at
23+
https://cyberbotics.com/doc/guide/using-python. This is especially important
24+
for people using macOS and Homebrew, you may need to set the full path to your
25+
Python interpreter (get it by `which python3`).

0 commit comments

Comments
 (0)