Merge pull request 'Update README.md' (#6) from arcmyx-dev into dev
Reviewed-on: Arcmyx/pybricks-utils#6
This commit is contained in:
11
README.md
11
README.md
@@ -2,9 +2,14 @@
|
||||
|
||||
A collection of Pybricks utilities to assist in your FLL robot programming with Python. Created by FLL team 65266, Lego Dynamics.
|
||||
|
||||
How to use this:
|
||||
|
||||
- Download the repository by clicking on the "Code" tab, clicking the "< > Code" button, then downloading as a ZIP. Additionally, you can also use ```git clone https://codes.fll-65266.org/Arcmyx/pybricks-utils.git```. Unzip the archive and open code.pybricks.com. Then choose which folder you'd like to use, and open each file in pybricks by using the import button. For example, to use the diagnostics tool, simply open each program in the ```diagnostics``` folder into Pybricks. Then, follow the instructions for each utility.
|
||||
|
||||
Included utilities:
|
||||
- Diagnostics - a program that prints out useful information like battery life, etc.
|
||||
- Color Sensor Tests - a program that identifies what color the sensor is detecting. If you'd like, you can use our color ranges in your own programs.
|
||||
|
||||
- Diagnostics - a program that allows you to diagnose issues and test parts of your robot, such as battery, motor, and color sensor. Open each program in the ```diagnostics``` folder in Pybricks, connect your robot, switch to the ```FullDiagnostics.py``` file and press run.
|
||||
- Color Sensor Tests (UPCOMING) - a program that identifies what color the sensor is detecting. If you'd like, you can use our color ranges in your own programs.
|
||||
|
||||
This code is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).
|
||||
|
||||
@@ -15,4 +20,4 @@ Without the confusing legal speak, this means that you are free to:
|
||||
Under the following condition:
|
||||
- Attribution (BY) — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. Essentially, give us credit, link this repository, and don't take the credit for our work, because that's just sad.
|
||||
|
||||
For the full legal details, please review the CC BY 4.0 Legal Code.
|
||||
For the full legal details, please review the CC BY 4.0 Legal Code (read the [LICENSE](LICENSE) file here).
|
||||
Reference in New Issue
Block a user