From 2e39514ee4481d8f2835d5bf77d0d783baf9554a Mon Sep 17 00:00:00 2001 From: James Munns Date: Tue, 13 Nov 2018 19:43:12 +0100 Subject: [PATCH] Index change, and some re-org --- src/SUMMARY.md | 34 ++++++++----------- src/c-tips/{c-tips.md => index.md} | 0 src/collections/{collections.md => index.md} | 0 src/concurrency/{concurrency.md => index.md} | 0 .../{interoperability.md => index.md} | 0 src/intro/{introduction.md => index.md} | 0 src/peripherals/{peripherals.md => index.md} | 0 src/portability/{portability.md => index.md} | 0 src/{start.md => start/index.md} | 0 .../design-contracts.md | 0 .../{static-guarantees.md => index.md} | 0 .../state-machines.md | 0 .../typestate-programming.md | 0 .../zero-cost-abstractions.md | 0 src/{unsorted.md => unsorted/index.md} | 0 15 files changed, 15 insertions(+), 19 deletions(-) rename src/c-tips/{c-tips.md => index.md} (100%) rename src/collections/{collections.md => index.md} (100%) rename src/concurrency/{concurrency.md => index.md} (100%) rename src/interoperability/{interoperability.md => index.md} (100%) rename src/intro/{introduction.md => index.md} (100%) rename src/peripherals/{peripherals.md => index.md} (100%) rename src/portability/{portability.md => index.md} (100%) rename src/{start.md => start/index.md} (100%) rename src/{typestate-programming => static-guarantees}/design-contracts.md (100%) rename src/static-guarantees/{static-guarantees.md => index.md} (100%) rename src/{typestate-programming => static-guarantees}/state-machines.md (100%) rename src/{typestate-programming => static-guarantees}/typestate-programming.md (100%) rename src/{typestate-programming => static-guarantees}/zero-cost-abstractions.md (100%) rename src/{unsorted.md => unsorted/index.md} (100%) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index c9bdb7c..825b5b9 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -4,12 +4,12 @@ Definition of the organization of this book is still a work in process. -Refer to https://github.com/rust-lang-nursery/embedded-wg/issues/115 for +Refer to https://github.com/rust-embedded/book/issues for more information and coordination --> -- [Introduction](./intro/introduction.md) +- [Introduction](./intro/index.md) - [`no_std`](./intro/no-std.md) - [Tooling](./intro/tooling.md) - [Installation](./intro/install.md) @@ -18,7 +18,7 @@ more information and coordination - [Windows](./intro/install/windows.md) - [Verify Installation](./intro/install/verify.md) - [Hardware](./intro/hardware.md) -- [Getting started](./start.md) +- [Getting started](./start/index.md) - [QEMU](./start/qemu.md) - [Hardware](./start/hardware.md) - [Memory-mapped Registers](./start/registers.md) @@ -26,26 +26,22 @@ more information and coordination - [Panicking](./start/panicking.md) - [Exceptions](./start/exceptions.md) - [IO](./start/io.md) -- [Peripherals](./peripherals/peripherals.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/static-guarantees.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) +- [Tips for embedded C developers](./c-tips/index.md) -- [Typestate Programming](./typestate-programming/typestate-programming.md) - - [Peripherals as State Machines](./typestate-programming/state-machines.md) - - [Design Contracts](./typestate-programming/design-contracts.md) - - [Zero Cost Abstractions](./typestate-programming/zero-cost-abstractions.md) -- [Portability](./portability/portability.md) - -- [Concurrency](./concurrency/concurrency.md) - -- [Collections](./collections/collections.md) - -- [Tips for embedded C developers](./c-tips/c-tips.md) - -- [Interoperability](./interoperability/interoperability.md) +- [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.md) +- [Unsorted topics](./unsorted/index.md) - [Optimizations: The speed size tradeoff](./unsorted/speed-vs-size.md) diff --git a/src/c-tips/c-tips.md b/src/c-tips/index.md similarity index 100% rename from src/c-tips/c-tips.md rename to src/c-tips/index.md diff --git a/src/collections/collections.md b/src/collections/index.md similarity index 100% rename from src/collections/collections.md rename to src/collections/index.md diff --git a/src/concurrency/concurrency.md b/src/concurrency/index.md similarity index 100% rename from src/concurrency/concurrency.md rename to src/concurrency/index.md diff --git a/src/interoperability/interoperability.md b/src/interoperability/index.md similarity index 100% rename from src/interoperability/interoperability.md rename to src/interoperability/index.md diff --git a/src/intro/introduction.md b/src/intro/index.md similarity index 100% rename from src/intro/introduction.md rename to src/intro/index.md diff --git a/src/peripherals/peripherals.md b/src/peripherals/index.md similarity index 100% rename from src/peripherals/peripherals.md rename to src/peripherals/index.md diff --git a/src/portability/portability.md b/src/portability/index.md similarity index 100% rename from src/portability/portability.md rename to src/portability/index.md diff --git a/src/start.md b/src/start/index.md similarity index 100% rename from src/start.md rename to src/start/index.md diff --git a/src/typestate-programming/design-contracts.md b/src/static-guarantees/design-contracts.md similarity index 100% rename from src/typestate-programming/design-contracts.md rename to src/static-guarantees/design-contracts.md diff --git a/src/static-guarantees/static-guarantees.md b/src/static-guarantees/index.md similarity index 100% rename from src/static-guarantees/static-guarantees.md rename to src/static-guarantees/index.md diff --git a/src/typestate-programming/state-machines.md b/src/static-guarantees/state-machines.md similarity index 100% rename from src/typestate-programming/state-machines.md rename to src/static-guarantees/state-machines.md diff --git a/src/typestate-programming/typestate-programming.md b/src/static-guarantees/typestate-programming.md similarity index 100% rename from src/typestate-programming/typestate-programming.md rename to src/static-guarantees/typestate-programming.md diff --git a/src/typestate-programming/zero-cost-abstractions.md b/src/static-guarantees/zero-cost-abstractions.md similarity index 100% rename from src/typestate-programming/zero-cost-abstractions.md rename to src/static-guarantees/zero-cost-abstractions.md diff --git a/src/unsorted.md b/src/unsorted/index.md similarity index 100% rename from src/unsorted.md rename to src/unsorted/index.md