Skip to content

Commit ec04430

Browse files
committed
Finish Getting Started changes.
Fixed feedback items from @WasabiFan
1 parent 4b33c0d commit ec04430

5 files changed

Lines changed: 62 additions & 75 deletions

File tree

docs/getting-started.md

Lines changed: 37 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ First, here are the things you need before starting:
3333
<span class="glyphicon glyphicon-alert"></span>
3434
The instructions on this page only apply to releases dated December
3535
2015 or later. Older releases are no longer supported. There are many major changes
36-
in this release, so if something seems broken or the documentation seems incorrect,
37-
please [open an issue on GitHub](../../support).
36+
in the December release, so if something seems broken or the documentation seems incorrect,
37+
please [open an issue on GitHub]({{ site.github.url }}/support).
3838
{:class="alert alert-warning"}
3939

4040
## Step 1: Download the latest ev3dev image file
@@ -90,7 +90,7 @@ LEDs indicate disk (SD card) activity.
9090
**Note:** If you are using Raspberry Pi hardware without a screen, just wait for
9191
the Activity LED to stop flashing, then go to the next step.
9292

93-
After about one minutes, the screen will go blank. This happens on the first boot
93+
After about one minute, the screen will go blank. This happens on the first boot
9494
only. The first boot takes longer than subsequent boots because the EV3
9595
has to create a unique SSH host ids and take care of a few other housekeeping
9696
items. After another minute or two, you will see the *brickman loading...* screen.
@@ -105,118 +105,88 @@ data may be lost. Keep in mind, that is may take a much longer time from 8V to
105105
6.5V than from 6.5V down to 5V!
106106

107107
<div class="panel panel-info">
108-
<div class="panel-heading">
109-
Troubleshooting tips if your EV3 won't boot
110-
</div>
111-
<div class="panel-body">
112-
<ul>
113-
<li>Make sure nothing is plugged into the EV3 (USB/sensors/motors/etc.)</li>
114-
<li>Try writing the image to the SD card again.</li>
115-
<li>You may have a bad/incompatible SD card - try a different SD card.</li>
116-
<li>Check the condition of the EV3 batteries.</li>
117-
</ul>
118-
</div>
108+
<div class="panel-heading">
109+
<span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
110+
Troubleshooting tips if your EV3 won't boot
111+
</div>
112+
<div class="panel-body" markdown="1">
113+
* Make sure nothing is plugged into the EV3 (USB/sensors/motors/etc.)
114+
* Try writing the image to the SD card again.
115+
* You may have a bad/incompatible SD card - try a different SD card.
116+
* Check the condition of the EV3 batteries.
117+
</div>
119118
</div>
120119

121120
## Step 4: Setup a network connection
122121

123122
There are lots of choices here. Your choice depends on what type of connection
124123
you want to use and on the OS of your host computer, so pick the one that applies:
125124

126-
* Ethernet over USB (just requires the USB cable that comes with the EV3)
125+
* __Ethernet over USB__ (just requires the USB cable that comes with the EV3)
127126
* [Connecting to the Internet](../tutorials/connecting-to-the-internet-via-usb) tutorial
128-
* USB Ethernet dongle (as in the kind with an RJ45 connector)
129-
* If your network has a DHCP server, this will "just work". See (non-existent) brickman
130-
docs for more info.
131-
* USB WiFi Dongle
127+
* __USB Ethernet dongle__ (as in the kind with an RJ45 connector)
128+
* If your network has a DHCP server, this will "just work".
129+
* __USB WiFi Dongle__
132130
* Hopefully you can figure it out. I'm putting off writing detailed docs
133131
until brickman is a bit more stable.
134-
* Bluetooth
132+
* __Bluetooth__
135133
* Note: Bluetooth may not work on the first boot. Please reboot if you see "???"
136134
after you power on Bluetooth.
137135
* [Connecting to the Internet](../tutorials/connecting-to-the-internet-via-bluetooth) tutorial
138136

139-
**Note:** For Raspberry Pi you must use the wired Ethernet port to connect for the
140-
first time. The default host name is `ev3dev-rpi` or `ev3dev-rpi2` depending
141-
on which model you have. You can setup additional connections using the
137+
<span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
138+
For Raspberry Pi with no display, you must use the wired Ethernet port
139+
to connect for the first time. You can setup additional connections using the
142140
`connmanctl` command.
141+
{: class="alert alert-info"}
143142

144143
## Step 5: First things to do with ev3dev
145144

146145
Here are some suggestions of some things you should do to get ev3dev setup.
146+
These commands are run on the EV3 in a terminal window. See the networking
147+
tutorials above if you don't know how to open terminal window and connect via SSH.
147148

148-
### Change your root password
149+
### Change your password
149150

150-
The default root password is r00tme - those are zeros, not "Ohs".
151+
The default password is `ev3dev`.
151152

152-
root@ev3dev:~# passwd
153+
robot@ev3dev:~$ passwd
153154
Enter new UNIX password:
154155
Retype new UNIX password:
155156
passwd: password updated successfully
156157

157-
### Set up a new user
158-
159-
Replace `user` with your actual user name and `First Last` with your real name
160-
(if you want it on the EV3 - you can leave it blank too). Don't miss the
161-
command to assign groups hiding at the end.
162-
163-
root@ev3dev:~# adduser user
164-
Adding user `user' ...
165-
Adding new group `user' (1001) ...
166-
Adding new user `user' (1001) with group `user' ...
167-
Creating home directory `/home/user' ...
168-
Copying files from `/etc/skel' ...
169-
Enter new UNIX password:
170-
Retype new UNIX password:
171-
passwd: password updated successfully
172-
Changing the user information for user
173-
Enter the new value, or press ENTER for the default
174-
Full Name []: First Last
175-
Room Number []:
176-
Work Phone []:
177-
Home Phone []:
178-
Other []:
179-
Is the information correct? [Y/n] y
180-
root@ev3dev:~# usermod -a -G sudo,ev3dev,plugdev,audio,video,input,bluetooth,i2c user
181-
182158
### Set the time zone
183159

184-
root@ev3dev:~# dpkg-reconfigure tzdata
160+
robot@ev3dev:~$ sudo dpkg-reconfigure tzdata
185161

186162
Then just follow the instructions on the screen.
187163

188-
**NOTE:** The EV3 does not have a battery backup for the realtime clock.
164+
<span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
165+
The EV3 and Raspberry Pi do not have a battery backup for the realtime clock.
189166
Whenever you remove the batteries, the clock will be reset. If the EV3 is
190167
connected to the Internet, the clock will be automatically set via NTP,
191168
otherwise, you can manually set the date/time with the `date` command.
192-
169+
{: class="alert alert-info"}
193170

194171
### Set the locale
195172

196173
You can skip this if en-US is OK.
197174

198-
root@ev3dev:~# dpkg-reconfigure locales
175+
robot@ev3dev:~$ sudo dpkg-reconfigure locales
199176

200177
### Update packages
201178

202-
<div class="alert alert-danger">
203-
<span class="glyphicon glyphicon-exclamation-sign"></span>
204-
If you are a beginner with Linux and/or Debian, you should skip updating packages
205-
for now. We are working on some major changes and things will be inconsisent with the
206-
documentation if you upgrade.
207-
</div>
208-
209179
Make sure your EV3 is connected to the Internet first.
210180
Updating the packages for the first time will take minutes.
211181
The duration depends on the speed class of the SD card and on the updates involved.
212182

213-
root@ev3dev:~# apt-get update
214-
root@ev3dev:~# apt-get upgrade
215-
root@ev3dev:~# apt-get dist-upgrade
183+
robot@ev3dev:~$ sudo apt-get update
184+
robot@ev3dev:~$ sudo apt-get upgrade
185+
robot@ev3dev:~$ sudo apt-get dist-upgrade
216186

217187
If a new kernel package is installed, you will need to reboot.
218188

219-
root@ev3dev:~# reboot
189+
robot@ev3dev:~$ sudo reboot
220190

221191
## Step 6: Do something awesome
222192

@@ -254,7 +224,7 @@ hang of it, you can even write your own interface library and have it listed her
254224
When you are ready to wish your EV3 goodnight, turn if off by pressing the
255225
*back* button from the main menu in brickman or pressing and holding the *back*
256226
button from any screen in brickman. This will open a dialog where you can select
257-
*Power Off* to turn off the EV3.
227+
*Power Off* to turn off the EV3. (Running `sudo poweroff` in a terminal works too.)
258228

259229
[microSD]: https://en.wikipedia.org/wiki/Secure_Digital#SD
260230
[microSDHC]: https://en.wikipedia.org/wiki/Secure_Digital#SDHC

docs/tutorials/connecting-to-the-internet-via-bluetooth.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@ title: Connecting to the Internet via Bluetooth
33
subject: Networking
44
---
55

6-
__Note:__ If you do not need to access the Internet from the EV3 brick, consider
6+
<span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
7+
If you do not need to access the Internet from the EV3 brick, consider
78
using [tethering] instead.
9+
{: .alert .alert-info}
810

911
[tethering]: /docs/tutorials/using-bluetooth-tethering
1012

11-
---
12-
13-
These instructions are for [brickman v0.5.0](http://www.ev3dev.org/news/2015/02/24/Package-Release/).
13+
<span class="glyphicon glyphicon-warning-sign" aria-hidden="true"></span>
14+
These instructions are for [brickman v0.7.0](http://www.ev3dev.org/news/2015/12/15/Package-Release/).
1415
If you are using an older version, please upgrade.
16+
{: .alert .alert-warning}
1517

1618
* {: tab="Android"}Note: These instructions were written using Android 4.1.2
1719
but should work for other versions as well.

docs/tutorials/connecting-to-the-internet-via-usb.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ using [tethering] instead.
1111
[tethering]: /docs/tutorials/using-usb-tethering
1212

1313
<span class="glyphicon glyphicon-warning-sign" aria-hidden="true"></span>
14-
These instructions are for [brickman v0.7.1](http://www.ev3dev.org/news/2015/02/24/Package-Release/).
14+
These instructions are for [brickman v0.7.0](http://www.ev3dev.org/news/2015/12/15/Package-Release/).
1515
If you are using an older version, please upgrade.
16-
{: class="alert alert-warning"}
16+
{: .alert .alert-warning}
1717

1818
* {: tab="Mac OSX"}<span class="glyphicon glyphicon-warning-sign" aria-hidden="true"></span>
1919
If you are using OS X version 10.11, this won't work. Apple broke the USB/CDC
@@ -42,11 +42,11 @@ If you are using an older version, please upgrade.
4242

4343
3. Click *Apply* to save your changes. After a short time, the ev3dev entry
4444
(or whatever you named it) should show connected and have a Self-Assigned
45-
IP address
45+
IP address.
4646

4747
{% include screenshot.html source="/images/osx/10.9/CDC-Connected.png" %}
4848

49-
4. To share our Internet connection with the EV3. Go back to *System
49+
4. To share our Internet connection with the EV3, go back to *System
5050
Preferences* and select *Sharing*.
5151

5252
{% include screenshot.html source="/images/osx/10.9/SystemPreferencesSharing.png" %}
@@ -272,6 +272,13 @@ If you are using an older version, please upgrade.
272272
{% include screenshot.html source="/images/windows/8/local-area-connection-properties-sharing-with-extra-selection.png" %}
273273
{: class="alert alert-info"}
274274

275+
<span class="glyphicon glyphicon-warning-sign" aria-hidden="true"></span>
276+
Windows Internet Connection Sharing is temperamental. Sometimes it just
277+
stops working for no reason. If this happens, just turn it off (by unchecking
278+
*Allow other...* and clicking *OK*) and then turn it back on. It should
279+
start working again.
280+
{: class="alert alert-warning"}
281+
275282
10. Click *OK* when you are done and close the status window as well. Windows
276283
will automatically reconfigure your other network connections.
277284

images/brickman/shutdown-menu.png

724 Bytes
Loading

stylesheets/bootstrap-extensions.css

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,14 @@ h1.panel-title {
128128
max-width: 350px;
129129
}
130130

131+
.inline-screenshot.pull-right {
132+
margin-left: 20px;
133+
}
134+
135+
.inline-screenshot.pull-left {
136+
margin-right: 20px;
137+
}
138+
131139
sup[id]:before {
132140
display: inline-block;
133141
}

0 commit comments

Comments
 (0)