New merge

README.md

@@ -1,16 +1,15 @@
 # The Embedded Rust Book
+> 一本关于如何使用Rust编程语言在裸板上开发固件的中文文档
 
-> Documentation on how to use the Rust Programming Language to develop firmware for bare metal (microcontroller) devices
-
-This project is developed and maintained by the [Resources team][team].
+这个项目由 [Resources team][team] 开发和维护。
 
 See [the issue tracker] for more details. This book is a living document, and is updated continuously.
 
 [the issue tracker]: /~https://github.com/rust-embedded/book/issues
 
 ## Online Copies of this Book
 
-This book is located at https://docs.rust-embedded.org/book/
+This book is located at https://xxchang.github.io/book/
 
 ## License
 

book.toml

@@ -1,8 +1,10 @@
 [book]
 authors = ["James Munns"]
+language = "zh-CN"
 multilingual = false
 src = "src"
 title = "The Embedded Rust Book"
 
 [output.html]
-git-repository-url = "/~https://github.com/rust-embedded/book"
+# git-repository-url = "/~https://github.com/rust-embedded/book"
+git-repository-url = "/~https://github.com/xxchang/book"

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

docs/index.md

@@ -0,0 +1,37 @@
+## Welcome to GitHub Pages
+
+You can use the [editor on GitHub](/~https://github.com/XxChang/book/edit/master/docs/index.md) to maintain and preview the content for your website in Markdown files.
+
+Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.
+
+### Markdown
+
+Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
+
+```markdown
+Syntax highlighted code block
+
+# Header 1
+## Header 2
+### Header 3
+
+- Bulleted
+- List
+
+1. Numbered
+2. List
+
+**Bold** and _Italic_ and `Code` text
+
+[Link](url) and ![Image](src)
+```
+
+For more details see [Basic writing and formatting syntax](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
+
+### Jekyll Themes
+
+Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](/~https://github.com/XxChang/book/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
+
+### Support or Contact
+
+Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out.

src/SUMMARY.md

@@ -9,52 +9,52 @@ more information and coordination
 
 -->
 
-- [Introduction](./intro/index.md)
-    - [Hardware](./intro/hardware.md)
+- [引言](./intro/index.md)
+    - [硬件](./intro/hardware.md)
     - [`no_std`](./intro/no-std.md)
-    - [Tooling](./intro/tooling.md)
-    - [Installation](./intro/install.md)
+    - [工具](./intro/tooling.md)
+    - [安装](./intro/install.md)
         - [Linux](./intro/install/linux.md)
         - [MacOS](./intro/install/macos.md)
         - [Windows](./intro/install/windows.md)
-        - [Verify Installation](./intro/install/verify.md)
-- [Getting started](./start/index.md)
+        - [验证工具链的安装](./intro/install/verify.md)
+- [开始](./start/index.md)
   - [QEMU](./start/qemu.md)
-  - [Hardware](./start/hardware.md)
-  - [Memory-mapped Registers](./start/registers.md)
-  - [Semihosting](./start/semihosting.md)
-  - [Panicking](./start/panicking.md)
-  - [Exceptions](./start/exceptions.md)
-  - [Interrupts](./start/interrupts.md)
+  - [硬件](./start/hardware.md)
+  - [存储映射的寄存器](./start/registers.md)
+  - [半主机模式](./start/semihosting.md)
+  - [运行时恐慌(Panicking)](./start/panicking.md)
+  - [异常](./start/exceptions.md)
+  - [中断](./start/interrupts.md)
   - [IO](./start/io.md)
-- [Peripherals](./peripherals/index.md)
-    - [A first attempt in Rust](./peripherals/a-first-attempt.md)
-    - [The Borrow Checker](./peripherals/borrowck.md)
-    - [Singletons](./peripherals/singletons.md)
-- [Static Guarantees](./static-guarantees/index.md)
-    - [Typestate Programming](./static-guarantees/typestate-programming.md)
-    - [Peripherals as State Machines](./static-guarantees/state-machines.md)
-    - [Design Contracts](./static-guarantees/design-contracts.md)
-    - [Zero Cost Abstractions](./static-guarantees/zero-cost-abstractions.md)
-- [Portability](./portability/index.md)
-- [Concurrency](./concurrency/index.md)
-- [Collections](./collections/index.md)
-- [Design Patterns](./design-patterns/index.md)
+- [外设](./peripherals/index.md)
+    - [Rust尝鲜](./peripherals/a-first-attempt.md)
+    - [借用检查器](./peripherals/borrowck.md)
+    - [单例](./peripherals/singletons.md)
+- [静态保障(static guarantees)](./static-guarantees/index.md)
+    - [类型状态编程](./static-guarantees/typestate-programming.md)
+    - [把外设当作状态机](./static-guarantees/state-machines.md)
+    - [设计约定](./static-guarantees/design-contracts.md)
+    - [零成本抽象](./static-guarantees/zero-cost-abstractions.md)
+- [可移植性](./portability/index.md)
+- [并发](./concurrency/index.md)
+- [容器](./collections/index.md)
+- [设计模式](./design-patterns/index.md)
     - [HALs](./design-patterns/hal/index.md)
-        - [Checklist](./design-patterns/hal/checklist.md)
-        - [Naming](./design-patterns/hal/naming.md)
-        - [Interoperability](./design-patterns/hal/interoperability.md)
-        - [Predictability](./design-patterns/hal/predictability.md)
+        - [列表](./design-patterns/hal/checklist.md)
+        - [命名](./design-patterns/hal/naming.md)
+        - [互操性](./design-patterns/hal/interoperability.md)
+        - [可预见性](./design-patterns/hal/predictability.md)
         - [GPIO](./design-patterns/hal/gpio.md)
-- [Tips for embedded C developers](./c-tips/index.md)
+- [给嵌入式C开发者的贴士](./c-tips/index.md)
     <!-- TODO: Define Sections -->
-- [Interoperability](./interoperability/index.md)
-    - [A little C with your Rust](./interoperability/c-with-rust.md)
-    - [A little Rust with your C](./interoperability/rust-with-c.md)
-- [Unsorted topics](./unsorted/index.md)
-  - [Optimizations: The speed size tradeoff](./unsorted/speed-vs-size.md)
-  - [Performing Math Functionality](./unsorted/math.md)
+- [互操性](./interoperability/index.md)
+    - [使用C的Rust](./interoperability/c-with-rust.md)
+    - [使用Rust的C](./interoperability/rust-with-c.md)
+- [没有排序的主题](./unsorted/index.md)
+  - [优化: 速度与大小间的博弈](./unsorted/speed-vs-size.md)
+  - [执行数学运算](./unsorted/math.md)
 
 ---
 
-[Appendix A: Glossary](./appendix/glossary.md)
+[附录A: 词汇表](./appendix/glossary.md)

src/appendix/glossary.md

@@ -1,64 +1,47 @@
-# Appendix A: Glossary
+# 附录A: 词汇表
 
-The embedded ecosystem is full of different protocols, hardware components and
-vendor-specific things that use their own terms and abbreviations. This Glossary
-attempts to list them with pointers for understanding them better.
+嵌入式生态系统中充满了不同的协议，硬件组件，还有许多与生产商相关的东西，它们都使用自己的缩写和项目名。这个词汇表尝试列出它们以便更好理解它们。
 
 ### BSP
 
-A Board Support Crate provides a high level interface configured for a specific
-board. It usually depends on a [HAL](#hal) crate.
-There is a more detailed description on the [memory-mapped registers page](../start/registers.md)
-or for a broader overview see [this video](https://youtu.be/vLYit_HHPaY).
+板级支持的Crate(Board Support Crate)提供为某个特定板子配置的高级接口。它通常依赖一个[HAL](#hal) crate 。在[存储映射的寄存器那页](../start/registers.md)有更多细节的描述或者看[这个视频](https://youtu.be/vLYit_HHPaY)来获取一个更广泛的概述。
 
 ### FPU
 
-Floating-point Unit. A 'math processor' running only operations on floating-point numbers.
+浮点单元(Floating-Point Unit)。一个只运行在浮点数上的'数学处理器'。
 
 ### HAL
 
-A Hardware Abstraction Layer crate provides a developer friendly interface to a microcontroller's
-features and peripherals. It is usually implemented on top of a [Peripheral Access Crate (PAC)](#pac).
-It may also implement traits from the [`embedded-hal`](https://crates.io/crates/embedded-hal) crate.
-There is a more detailed description on the [memory-mapped registers page](../start/registers.md)
-or for a broader overview see [this video](https://youtu.be/vLYit_HHPaY).
+硬件抽象层(Hardware Abstraction Layer) crate为微控制器的功能和外设提供一个开发者友好的接口。它通常在[Peripheral Access Crate (PAC)](#pac)之上被实现。它可能也会实现来自[`embedded-hal`](https://crates.io/crates/embedded-hal) crate的traits 。在[存储映射的寄存器那页](../start/registers.md)上有更多的细节或者看[这个视频](https://youtu.be/vLYit_HHPaY)获取一个更广泛的概述。
 
 ### I2C
 
-Sometimes referred to as `I²C` or Inter-IC. It is a protocol meant for hardware communication
-within a single integrated circuit. See [here][i2c] for more details
+有时又被称为 `I²C` 或者 Intere-IC 。它是一种用于在单个集成电路中进行硬件通信的协议。看[这里][i2c]来获取更多细节。
 
 [i2c]: https://en.wikipedia.org/wiki/I2c
 
 ### PAC
 
-A Peripheral Access Crate provides access to a microcontroller's peripherals. It is one of
-the lower level crates and is usually generated directly from the provided [SVD](#svd), often
-using [svd2rust](/~https://github.com/rust-embedded/svd2rust/). The [Hardware Abstraction Layer](#hal)
-would usually depend on this crate.
-There is a more detailed description on the [memory-mapped registers page](../start/registers.md)
-or for a broader overview see [this video](https://youtu.be/vLYit_HHPaY).
+一个外设访问 Crate (Peripheral Access Crate)提供了对一个微控制器的外设的访问。它是一个底层的crates且通常从提供的[SVD](#svd)被直接生成，经常使用[svd2rust](/~https://github.com/rust-embedded/svd2rust/)。[硬件抽象层](#hal)应该依赖这个crate。在[存储映射的寄存器那页](../start/registers.md)有更细节的描述或者看[这个视频](https://youtu.be/vLYit_HHPaY)获取一个更广泛的概述。
 
 ### SPI
 
-Serial Peripheral Interface. See [here][spi] for more information.
+串行外设接口。看[这里][spi]获取更多信息。
 
 [spi]: https://en.wikipedia.org/wiki/Serial_peripheral_interface
 
 ### SVD
 
-System View Description is an XML file format used to describe the programmers view of a
-microcontroller device. You can read more about it on
-[the ARM CMSIS documentation site](https://www.keil.com/pack/doc/CMSIS/SVD/html/index.html).
+系统视图描述文件(System View Description)是一个XML文件格式，以程序员视角来描述一个微控制器设备。你能在[the ARM CMSIS documentation site](https://www.keil.com/pack/doc/CMSIS/SVD/html/index.html)上获取更多信息。
 
 ### UART
 
-Universal asynchronous receiver-transmitter. See [here][uart] for more information.
+通用异步收发器。看[这里][uart]获取更多信息。
 
 [uart]: https://en.wikipedia.org/wiki/Universal_asynchronous_receiver-transmitter
 
 ### USART
 
-Universal synchronous and asynchronous receiver-transmitter. See [here][usart] for more information.
+通用同步异步收发器。看[这里][usart]获取更多信息。
 
 [usart]: https://en.wikipedia.org/wiki/Universal_synchronous_and_asynchronous_receiver-transmitter