diff --git a/source/conf.py b/source/conf.py index 8dacff4..4873ecc 100644 --- a/source/conf.py +++ b/source/conf.py @@ -89,8 +89,6 @@ language = None # This patterns also effect to html_static_path and html_extra_path exclude_patterns = [ 'motorcontrol.rst', - 'startinstall.rst', - 'startrun.rst', ] # TODO: remove this when pages above are added back in diff --git a/source/images/connecting.png b/source/images/connecting.png index 62d46e4..00f84c3 100644 Binary files a/source/images/connecting.png and b/source/images/connecting.png differ diff --git a/source/images/connecting.svg b/source/images/connecting.svg new file mode 100644 index 0000000..f739cb9 --- /dev/null +++ b/source/images/connecting.svg @@ -0,0 +1,428 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + Open file tab + + 1 + + + + + + + Open device browser + + 3 + + + + + Search for your EV3 + + 4 + + + + + Select your EV3 + + 5 + + + + Connect your EV3 with the USB cable + 4 + + 2 + + + diff --git a/source/images/connectingsub1.png b/source/images/connectingsub1.png new file mode 100644 index 0000000..cb7dbb2 Binary files /dev/null and b/source/images/connectingsub1.png differ diff --git a/source/images/connectingsub2.png b/source/images/connectingsub2.png new file mode 100644 index 0000000..f84cb22 Binary files /dev/null and b/source/images/connectingsub2.png differ diff --git a/source/images/newproject.png b/source/images/newproject.png index 231337f..e80dc6e 100644 Binary files a/source/images/newproject.png and b/source/images/newproject.png differ diff --git a/source/images/newproject.svg b/source/images/newproject.svg new file mode 100644 index 0000000..5d0e985 --- /dev/null +++ b/source/images/newproject.svg @@ -0,0 +1,276 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + Choose a location for yourproject in the pop-up window + + 4 + + + + + Open Pybricks tab + + 1 + + + + Create new project + + 2 + + + + + Choose a project name and press enter + + 3 + + diff --git a/source/images/overview.jpg b/source/images/overview.jpg new file mode 100644 index 0000000..eee1e3a Binary files /dev/null and b/source/images/overview.jpg differ diff --git a/source/images/overview.png b/source/images/overview.png deleted file mode 100644 index bb28118..0000000 Binary files a/source/images/overview.png and /dev/null differ diff --git a/source/images/overview.svg b/source/images/overview.svg new file mode 100644 index 0000000..1ffdf5f --- /dev/null +++ b/source/images/overview.svg @@ -0,0 +1,256 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + Computer with Visual Studio Code + + + + + + Download and run + + + + Micro SD card withEV3 Python Firmware + + + + + EV3 Brick + + + + + Mini USB cable + + diff --git a/source/images/projectoverview.png b/source/images/projectoverview.png index e47311c..c62fbcf 100644 Binary files a/source/images/projectoverview.png and b/source/images/projectoverview.png differ diff --git a/source/images/projectoverview.svg b/source/images/projectoverview.svg new file mode 100644 index 0000000..c688e6a --- /dev/null +++ b/source/images/projectoverview.svg @@ -0,0 +1,212 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + Write your program + + 2 + + + + Open main.py + + 1 + + + + + + + diff --git a/source/images/render.sh b/source/images/render.sh new file mode 100755 index 0000000..1a8e7eb --- /dev/null +++ b/source/images/render.sh @@ -0,0 +1,6 @@ +#!/usr/bin/env bash + +for filenamedotext in *.svg; do + filename=$(echo "$filenamedotext" | cut -f 1 -d '.') + inkscape --file=$filename.svg --export-area-drawing --export-png=build/$filename.png +done diff --git a/source/images/running.png b/source/images/running.png index dcbafdd..0a0d3bc 100644 Binary files a/source/images/running.png and b/source/images/running.png differ diff --git a/source/images/running.svg b/source/images/running.svg new file mode 100644 index 0000000..3a81679 --- /dev/null +++ b/source/images/running.svg @@ -0,0 +1,323 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + Output + + 3 + + + + + Debug (or press F5) + + 1 + + + + + Download and run + + 2 + + + + + Download and run + + 2 + + + + + Stop + + 4 + diff --git a/source/images/vsix.png b/source/images/vsix.png index 9ebbbb7..4137d48 100644 Binary files a/source/images/vsix.png and b/source/images/vsix.png differ diff --git a/source/images/vsix.svg b/source/images/vsix.svg new file mode 100644 index 0000000..55ad511 --- /dev/null +++ b/source/images/vsix.svg @@ -0,0 +1,266 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + More Actions + + 2 + + + + + Extensions + + 1 + + + + + Install from VSIX + + 3 + + + + diff --git a/source/index.rst b/source/index.rst index 2df9b25..28294b8 100644 --- a/source/index.rst +++ b/source/index.rst @@ -6,12 +6,12 @@ Using Python with LEGO\ :sup:`®` MINDSTORMS\ :sup:`®` EV3 ========================================================= -.. .. toctree:: -.. :maxdepth: 1 -.. :caption: Getting started: +.. toctree:: + :maxdepth: 1 + :caption: Getting started: -.. startinstall -.. startrun + startinstall + startrun .. toctree:: diff --git a/source/startinstall.rst b/source/startinstall.rst index 23544b3..8345f2b 100644 --- a/source/startinstall.rst +++ b/source/startinstall.rst @@ -4,7 +4,9 @@ Installation This page shows how you prepare your computer and the EV3 brick for writing and running Python programs. The final configuration is shown in the figure below. -.. image:: images/overview.png +.. figure:: images/build/overview.png + +.. Caption What do you need? ----------------------------------------------------------- @@ -21,18 +23,18 @@ You'll need internet access to complete the steps on this page. While programmin Preparing your computer ----------------------------------------------------------- -.. note:: +.. warning:: - + The download links below do not work yet. Please follow the instructions provided separately. You will be writing your Python programs using Visual Studio Code. You can download, install, and configure this program using the steps below. 1. Download, install, and open `Visual Studio Code `_. -2. Download the `Pybricks extension `_. Follow the steps in the diagram below to install it. -3. Download the `EV3 Python extension `_. Follow the steps in the diagram below to install it. +2. Download the `Pybricks extension <.>`_. Follow the steps in the diagram below to install it. +3. Download the `EV3 Python extension <.>`_. Follow the steps in the diagram below to install it. 4. Close Visual Studio Code and open it again to activate the extensions. -.. image:: images/vsix.png +.. image:: images/build/vsix.png Preparing the SD Card ----------------------------------------------------------- @@ -40,18 +42,12 @@ Preparing the SD Card You will now follow a series of steps to download and install the EV3 Python firmware onto your micro SD card. -1. Download the `EV3 Python firmware `_ and save it in a convenient location. Do *not* unzip the file. +1. Download the `EV3 Python firmware <.>`_ and save it in a convenient location. Do *not* unzip the file. 2. Download and install `Etcher `_. This is the program for installing the firmware file on your micro SD card. 3. Insert the micro SD card into your computer or card reader. 4. Launch the etcher program and follow the steps on your screen to install the firmware file you have just downloaded. Do not remove the card until the installation process is complete. -5. Put the micro SD card in the SD card slot of the EV3 brick. - - -.. todo:: - - - images of the etcher process - - image of inserting an SD card into the brick - - write the following sections +5. Turn the EV3 brick off if it is currently on. +6. Put the micro SD card in the SD card slot of the EV3 brick. Using the EV3 brick diff --git a/source/startrun.rst b/source/startrun.rst index 1d908c3..fea10cc 100644 --- a/source/startrun.rst +++ b/source/startrun.rst @@ -4,14 +4,14 @@ Creating and running programs Starting a new project ----------------------------------------------------------- -.. image:: images/newproject.png +.. image:: images/build/newproject.png Example text Understanding projects folder and files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: images/projectoverview.png +.. image:: images/build/projectoverview.png Example text @@ -25,14 +25,14 @@ Running a program Connecting the EV3 brick and the computer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: images/connecting.png +.. image:: images/build/connecting.png Example text Downloading and running a program ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: images/running.png +.. image:: images/build/running.png Example text