88 Commits

Author SHA1 Message Date
原田莓莓
b46dbba837 修正 no_std 翻译错误
In a bare metal environment no code has been loaded before your program.
2020-05-26 21:33:35 +08:00
bai
f718cb36aa 更新地址信息 2020-05-26 20:25:04 +08:00
bai
7c56bf812f 校正2 2020-05-26 20:13:57 +08:00
bai
753b654ef9 校正 2020-05-06 13:26:23 +08:00
bai
69f9a39b72 第一版本,完整翻译 2020-05-06 11:27:43 +08:00
bors[bot]
e3b0e42b2a Merge #213
213: Adds cargo-generate to installation instructions r=jamesmunns a=rubberduck203

Fixes #186
Related to 753d71ac, which added instructions close to use in the qemu
page, this commit adds the information directly to install where it's
less likely to be overlooked.

Co-authored-by: Christopher J. McClellan <cmcclellan@pillartechnology.com>
2020-04-26 17:42:57 +00:00
Jonathan 'theJPster' Pallant
7edcc136ae Add licence notes to index.md
After discussions with someone who had re-used material without attribution, we agreed it would be useful to make the licence terms more prominent to those reading the rendered book (as opposed to browsing the Github repo).
2020-02-17 15:55:12 +00:00
Philipp Hansch
9070d63581 Mention discovery book more prominently 2020-01-06 07:39:27 +01:00
Christopher J. McClellan
4498062af7 Adds cargo-generate to installation instructions
Fixes #186
Related to 753d71ac, which added instructions close to use in the qemu
page, this commit adds the information directly to install where it's
less likely to be overlooked.
2019-11-19 19:42:11 -05:00
Antonio Gutierrez
db6bd32c66 install/verify: Fix broken link pointed by bors
Signed-off-by: Antonio Gutierrez <chibby0ne@gmail.com>
2019-08-06 00:56:25 +02:00
Antonio Gutierrez
f106cba28e install/verify: fix next section link
The next section in the book is the "Getting Started", not the already
seen section Hardware in the same chapter.

Signed-off-by: Antonio Gutierrez <chibby0ne@gmail.com>
2019-08-05 23:58:42 +02:00
Vadim Kaushan
abb79175fb Remove obsoleve AUR instructions 2019-05-01 21:38:22 +02:00
Vadim Kaushan
4f7338edc9 Merge branch 'master' into patch-10 2019-05-01 21:36:31 +02:00
bors[bot]
8f366fec4f Merge #165
165: Clarify list of available targets for installation r=korken89 a=adamgreig



Co-authored-by: Adam Greig <adam@adamgreig.com>
2019-05-01 15:35:35 +00:00
Erich Schroeter
df601ce501 minor grammar fix 2019-04-29 13:30:12 -05:00
nickgolangi
2546d1771b Grammar fix 2019-04-20 12:01:43 -04:00
Marcel Müller
b85f872b72 Add openocd to list of installable packages
The openocd package is now in the community repository of Archlinux.

https://www.archlinux.org/packages/community/x86_64/openocd/
2019-03-14 16:31:21 +01:00
Christopher Anderson
61cba82edc Update no-std.md to remove obsolete FAQ link
Per issue #97
2019-03-10 13:54:59 -07:00
Eric Huss
915b85bb5a Update some book links to their new homes. 2019-03-04 10:03:16 -08:00
Thomas Niederberger
133f4f069e Small text changes 2019-03-03 15:30:59 +01:00
bors[bot]
2503da484f Merge #172
172: Update tooling.md r=japaric a=flip111

https://github.com/rust-embedded/book/issues/143

Co-authored-by: flip111 <flip101@gmail.com>
2019-02-19 09:53:33 +00:00
bors[bot]
9dc02c120e Merge #169
169: Update hardware.md r=therealprof a=flip111

https://github.com/rust-embedded/book/issues/140

Co-authored-by: flip111 <flip101@gmail.com>
Co-authored-by: Daniel Egger <daniel@eggers-club.de>
2019-02-18 23:08:12 +00:00
Daniel Egger
7014327b9c Update src/intro/hardware.md
Co-Authored-By: flip111 <flip101@gmail.com>
2019-02-18 23:05:03 +00:00
flip111
d17fac823a Update hardware.md 2019-02-18 22:55:30 +00:00
flip111
8893a33bf8 Update hardware.md 2019-02-18 22:18:39 +00:00
flip111
ee2cd6d5c1 Update tooling.md 2019-02-18 21:52:29 +00:00
Vítor Galvão
73a4a5876b install-macos: remove Homebrew tap command 2019-02-18 21:24:13 +00:00
flip111
89aff29646 Update hardware.md 2019-02-18 20:26:53 +00:00
flip111
a2e16ac91f Update linux.md 2019-02-18 20:02:07 +00:00
Adam Greig
b1b0389602 Clarify list of available targets for installation 2019-02-17 16:16:01 -07:00
bors[bot]
f42b1b26ef Merge #133 #135
133: Update no-std.md r=korken89 a=flip111

* There is no high level OS this means there are no primitives <-- this is wrong because there can be primitives without high level OS otherwise it wouldn't be a "primitive"
* Using jargon "bare metal" without explaining it
* By marking our code with `no_std` we indicate that our code is capable of running in such an environment. <-- this wording makes it so that using `no_std` is the only requirement of having runnable code.
* Dynamic memory allocation can not be used --> not true, use crate (like described lower in the text)

135: Update install.md r=korken89 a=flip111

`For bandwidth and disk usage concerns the default installation only supports native compilation.`
I like what the default installation is doing, not downloading toolchains i don't need. Let's do the same for the book. At the same time, because the reader is just getting into embedded for rust, it's cool to see which toolchains for which CPU cores are already available. This gives a good feeling of control (which toolchain i can choose) and possibilities (many to choose from)

Co-authored-by: flip111 <flip101@gmail.com>
2019-02-17 15:47:23 +00:00
flip111
21712a35db Update install.md
`For bandwidth and disk usage concerns the default installation only supports native compilation.`
I like what the default installation is doing, not downloading toolchains i don't need. Let's do the same for the book. At the same time, because the reader is just getting into embedded for rust, it's cool to see which toolchains for which CPU cores are already available. This gives a good feeling of control (which toolchain i can choose) and possibilities (many to choose from)
2019-02-17 01:16:20 +00:00
flip111
f5467acc83 Update no-std.md
* There is no high level OS this means there are no primitives <-- this is wrong because there can be primitives without high level OS otherwise it wouldn't be a "primitive"
* Using jargon "bare metal" without explaining it
* By marking our code with `no_std` we indicate that our code is capable of running in such an environment. <-- this wording makes it so that using `no_std` is the only requirement of having runnable code.
* Dynamic memory allocation can not be used --> not true, use crate (like described lower in the text)
2019-02-17 01:01:14 +00:00
James Munns
21644fb066 Remove old warning 2019-02-06 15:37:03 +01:00
Daniel Egger
3e9429de59 Update macOS installation instructions
Fixes #118
2019-01-25 08:47:01 +01:00
Andrea Lattuada
730dc7d39b beta compiler is not needed anymore 2018-12-28 21:32:57 +01:00
Eddy Petrișor
aadfc95f85 install:linux: Recommend using apt instead of apt-get
The 'apt' binary has appeared in apt 1.0 back in 2014 and has been
ever since the recommended tool to install packages on Debian based
systems.  It makes little sense to recommend using 'apt-get' instead
of 'apt' when even the current Debian oldstable - jessie - has apt
>=1.0.9.8 and the Ubuntu 14.04 LTS - trusty - has apt
>=1.0.1ubuntu1.

Signed-off-by: Eddy Petrișor <eddy.petrisor@gmail.com>
2018-12-14 23:55:59 +02:00
Adam Green
0092d74c7b Add '#' to URLs when appropriate anchors exist on page
For example there is a udev-rules anchor on the linux.md page so that
clicking on a [udev rules] link can jump to that specifc part of the
page.
2018-11-16 22:58:36 -08:00
Adam Green
01327046e3 A few fixes to chapter 1 2018-11-16 22:15:40 -08:00
James Munns
2e39514ee4 Index change, and some re-org 2018-11-13 19:49:35 +01:00
bors[bot]
ec90335f16 Merge #74
74: edits to the introduction chapter r=jamesmunns a=japaric

see individual commit messages for details

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
2018-11-10 15:06:06 +00:00
Jonathan 'theJPster' Pallant
16c8d1f44d Update comments on heap availability on no_std.
As per https://github.com/rust-embedded/book/issues/33.
2018-11-09 21:36:00 +00:00
Jorge Aparicio
9da22bdd21 move sections around
explain the tools before showing the installation steps

cover no_std before the tooling
2018-11-09 21:38:41 +01:00
Jorge Aparicio
15c4b8f60b remove warnings 2018-11-09 21:38:41 +01:00
Jorge Aparicio
6ad3574b43 recommend 1.31-beta 2018-11-09 21:38:41 +01:00
Jorge Aparicio
d6ab8b0f65 s/version/section 2018-11-09 21:38:41 +01:00
Jorge Aparicio
a3b4dcbefd remove link to the second edition of the Rust book
its content is pretty similar to the 2018 edition and we want to reader to be
familiar with the 2018 edition so it's best to direct them to that version of
the Rust book
2018-11-09 21:38:41 +01:00
Adam Green
ca53060125 Update doc URLs to new location
Documentation was recently moved to docs.rust-embedded.org and some of
the old links (to bookshelf content) now result in 404 errors.
2018-11-07 00:23:03 -08:00
bors[bot]
f0846613f7 Merge #67
67: Attempt to describe OpenOCD r=japaric a=adamgreen

This is my attempt to implement the OpenOCD TODO item in the 'Tooling'
section of Chapter 1.

I did move the OpenOCD section so that it comes after GDB since I
thought it made more sense to describe it after the user has already
been introduced to GDB as a debugger since it is OpenOCD which bridges
the gap between GDB and the ST-Link debugger hardware.

Feedback welcome!

Co-authored-by: Adam Green <adamgreen@users.noreply.github.com>
2018-11-05 01:14:04 +00:00
Jorge Aparicio
e310669d0e canonicalize URLs
as per #55

closes #55
2018-11-04 23:44:15 +01:00