From be6194d9000791ae0eeb1f1b3b777f09f265a5be Mon Sep 17 00:00:00 2001 From: Jason Kridner <jkridner@beagleboard.org> Date: Wed, 6 Jul 2022 16:15:48 -0400 Subject: [PATCH] support/getting-started: whitespace fixes --- support/getting-started.rst | 84 ++++++++++++++++++------------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/support/getting-started.rst b/support/getting-started.rst index 14e9d79f..7ab30f00 100644 --- a/support/getting-started.rst +++ b/support/getting-started.rst @@ -3,24 +3,24 @@ Getting Started ================== -Beagles are tiny computers ideal for learning and prototyping with electronics. +Beagles are tiny computers ideal for learning and prototyping with electronics. Read the step-by-step getting started tutorial below to begin developing with your Beagle in minutes. Update board with latest software ------------------------------------ -This step may or may not be necessary, depending on how old a software image you already have, +This step may or may not be necessary, depending on how old a software image you already have, but executing this, the longest, step will ensure the rest will go as smooth as possible. Download the latest software image ******************************************** -Download the lastest Debian image from `beagleboard.org/latest-images <https://beagleboard.org/latest-images>`_. -The "IoT" images provide more free disk space if you don't need to use a graphical user interface (GUI). +Download the lastest Debian image from `beagleboard.org/latest-images <https://beagleboard.org/latest-images>`_. +The "IoT" images provide more free disk space if you don't need to use a graphical user interface (GUI). -.. NOTE:: - Due to sizing necessities, this download may take 30 minutes or more. +.. NOTE:: + Due to sizing necessities, this download may take 30 minutes or more. -The Debian distribution is provied for the boards. The file you download will have an .img.xz extension. +The Debian distribution is provied for the boards. The file you download will have an .img.xz extension. This is a compressed sector-by-sector image of the SD card. |image0| @@ -40,7 +40,7 @@ Use your computer's SD slot or a USB adapter to connect the SD card to your comp Write the image to your SD card ***************************************** -Use Etcher to write the image to your SD card. Etcher will transparently decompress the +Use Etcher to write the image to your SD card. Etcher will transparently decompress the image on-the-fly before writing it to the SD card. |image3| @@ -51,29 +51,29 @@ Eject the newly programmed SD card. Boot your board off of the SD card ******************************************** -Insert SD card into your (powered-down) board, hold down the USER/BOOT button (if using Black) -and apply power, either by the USB cable or 5V adapter. +Insert SD card into your (powered-down) board, hold down the USER/BOOT button +and apply power, either by the USB cable or 5V adapter. -If using an original BeagleBone or PocketBeagle, you are done. +If using an original BeagleBone or PocketBeagle, you are done. -If using BeagleBone Black, BeagleBone Blue, BeagleBone AI, BeagleBone AI-64 or other board with on-board eMMC -flash and you desire to write the image to your on-board eMMC, you'll need to follow the -instructions at http://elinux.org/Beagleboard:BeagleBoneBlack_Debian#Flashing_eMMC. -When the flashing is complete, all 4 USRx LEDs will be steady on or off. The latest Debian -flasher images automatically power down the board upon completion. This can take up to 45 minutes. +If using BeagleBone Black, BeagleBone Blue, BeagleBone AI, BeagleBone AI-64 or other board with on-board eMMC +flash and you desire to write the image to your on-board eMMC, you'll need to follow the +instructions at http://elinux.org/Beagleboard:BeagleBoneBlack_Debian#Flashing_eMMC. +When the flashing is complete, all 4 USRx LEDs will be steady on or off. The latest Debian +flasher images automatically power down the board upon completion. This can take up to 45 minutes. Power-down your board, remove the SD card and apply power again to finish. Start your Beagle ------------------ -If any step fails, it is recommended to update to the -`latest software image <https://beagleboard.org/latest-images>`_ +If any step fails, it is recommended to update to the +`latest software image <https://beagleboard.org/latest-images>`_ using the instructions above. Power and boot ---------------- -Most Beagles can be powered via a USB cable, providing a convenient way to provide both power to your +Most Beagles can be powered via a USB cable, providing a convenient way to provide both power to your Beagle and connectivity to your computer. Be sure the cable is of good quality and your source can provide enough power. Alternatively, your Beagle may have a barrel jack. @@ -81,11 +81,11 @@ Alternatively, your Beagle may have a barrel jack. .. Note:: Use only a 5V center positive adapter for all Beagles except BeagleBone Blue and BeagleBoard-X15 (12V). -If you are using your Beagle with an `SD (microSD) card <https://en.wikipedia.org/wiki/Secure_Digital>`_, make sure it is inserted ahead of providing power. +If you are using your Beagle with an `SD (microSD) card <https://en.wikipedia.org/wiki/Secure_Digital>`_, make sure it is inserted ahead of providing power. Most Beagles include programmed on-board flash and therefore do not require an SD card to be inserted. -You'll see the power (PWR or ON) LED lit steadily. Within a minute or so, you should see the other LEDs -blinking in their default configurations. Consult the Quick Start Guide (QSG) or System Reference +You'll see the power (PWR or ON) LED lit steadily. Within a minute or so, you should see the other LEDs +blinking in their default configurations. Consult the Quick Start Guide (QSG) or System Reference Manual (SRM) for your board to locate these LEDs. - USR0 is typically configured at boot to blink in a heartbeat pattern. @@ -97,21 +97,21 @@ Manual (SRM) for your board to locate these LEDs. Enable a network connection ---------------------------- -If connected via USB, a network adapter should show up on your computer. -Your Beagle should be running a DHCP server that will provide your computer -with an IP address of either 192.168.7.1 or 192.168.6.1, depending on the -type of USB network adapter supported by your computer's operating system. +If connected via USB, a network adapter should show up on your computer. +Your Beagle should be running a DHCP server that will provide your computer +with an IP address of either 192.168.7.1 or 192.168.6.1, depending on the +type of USB network adapter supported by your computer's operating system. Your Beagle will reserve 192.168.7.2 or 192.168.6.2 for itself. -If your Beagle includes WiFi, an access point called "BeagleBone-XXXX" where "XXXX" -varies between boards. The access point password defaults to "BeagleBone". -Your Beagle should be running a DHCP server that will provide your computer +If your Beagle includes WiFi, an access point called "BeagleBone-XXXX" where "XXXX" +varies between boards. The access point password defaults to "BeagleBone". +Your Beagle should be running a DHCP server that will provide your computer with an IP address in the 192.168.8.x range and reserve 192.168.8.1 for itself. -If your Beagle is connected to your local area network (LAN) via either Ethernet or WiFi, -it will utilize `mDNS <https://en.wikipedia.org/wiki/Multicast_DNS>`_ to broadcast itself -to your computer. If your computer supports mDNS, you should see your Beagle as beaglebone.local. -Non-BeagleBone boards will utilize alternate names. Multiple BeagleBone boards on the same +If your Beagle is connected to your local area network (LAN) via either Ethernet or WiFi, +it will utilize `mDNS <https://en.wikipedia.org/wiki/Multicast_DNS>`_ to broadcast itself +to your computer. If your computer supports mDNS, you should see your Beagle as beaglebone.local. +Non-BeagleBone boards will utilize alternate names. Multiple BeagleBone boards on the same network will add a suffix such as beaglebone-2.local. Browse to your Beagle @@ -120,8 +120,8 @@ Browse to your Beagle A web server with an IDE should be running on your Beagle. Point your browser to it to begin development. .. NOTE:: - Use either `Firefox <https://www.mozilla.org/firefox>`_ or `Chrome <https://www.google.com/chrome>`_ - (Internet Explorer will NOT work), browse to the web server running on your board. It will load a presentation + Use either `Firefox <https://www.mozilla.org/firefox>`_ or `Chrome <https://www.google.com/chrome>`_ + (Internet Explorer will NOT work), browse to the web server running on your board. It will load a presentation showing you the capabilities of the board. Use the arrow keys on your keyboard to navigate the presentation. The below table summarizes the typical addresses. @@ -153,13 +153,13 @@ Troubleshooting Do not use Internet Explorer. -Virtual machines are not recommended when using the direct USB connection. +Virtual machines are not recommended when using the direct USB connection. It is recommended you use only network connections to your board if you are using a virtual machine. When using 'ssh' with the provided image, the username is 'debian' and the password is 'temppwd'. -With the latest images, it should no longer be necessary to install drivers for your operating -system to give you network-over-USB access to your Beagle. In case you are running an older image, +With the latest images, it should no longer be necessary to install drivers for your operating +system to give you network-over-USB access to your Beagle. In case you are running an older image, an older operating system or need additional drivers for serial access to older boards, links to the old drivers are below. .. list-table:: @@ -173,7 +173,7 @@ an older operating system or need additional drivers for serial access to older - If in doubt, try the 64-bit installer first. * - Windows (32-bit) - `32-bit installer <https://beagleboard.org/static/Drivers/Windows/BONE_DRV.exe>`_ - - + - * - Mac OS X - `Network Serial <https://beagleboard.org/static/Drivers/MacOSX/FTDI/EnergiaFTDIDrivers2.2.18.pkg>`_ - Install both sets of drivers. @@ -215,13 +215,13 @@ Perfect for high-school seniors or freshman univerisity level text, consider usi `BeagleBone Cookbook <https://bbb.io/cookbook>`_ -A lighter treatment suitable for a bit broader audience without the backgrounders on programming and +A lighter treatment suitable for a bit broader audience without the backgrounders on programming and electronics, consider "BeagleBone Cookbook" `Exploring BeaglebBone <https://bbb.io/ebb>`_ and `Embedded Linux Primer <https://bbb.io/elp>`_ -To take things to the next level of detail, consider "Exploring BeagleBone" which can be considered -the missing software manual and utilize "Embedded Linux Primer" as a companion textbook to provide +To take things to the next level of detail, consider "Exploring BeagleBone" which can be considered +the missing software manual and utilize "Embedded Linux Primer" as a companion textbook to provide a strong base on embedded Linux suitable for working with any hardware that will run Linux. .. |image0| image:: images/download-latestimage.png -- GitLab