diff --git a/.gitignore b/.gitignore index 116affc..714c6f3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ book notes +src/tmp diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 0f0effa..e73b236 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,20 +1,20 @@ # Summary -- [Introduction](./chapter_1.md) -- [Hardware](./chapter_2.md) - - [Requirements](./chapter_2_1.md) - - [GPIO Pinout](./chapter_2_2.md) - - [Physical Interface](./chapter_2_3.md) -- [Software](./chapter_3.md) - - [Operating System](./chapter_3_1.md) - - [Networking](./chapter_3_1_1.md) - - [Microservices](./chapter_3_2.md) - - [peach-buttons](./chapter_3_2_1.md) - - [peach-menu](./chapter_3_2_2.md) - - [peach-network](./chapter_3_2_3.md) - - [peach-oled](./chapter_3_2_4.md) - - [peach-stats](./chapter_3_2_5.md) - - [Web Interface](./chapter_3_3.md) - - [Configuration](./chapter_3_4.md) -- [Contributor's Guide](./chapter_4.md) -- [Licensing](./chapter_5.md) +- [Introduction](./introduction.md) +- [Hardware](./hardware/index.md) + - [Requirements](./hardware/requirements.md) + - [GPIO Pinout](./hardware/gpio_pinout.md) + - [Physical Interface](./hardware/physical_interface.md) +- [Software](./software/index.md) + - [Operating System](./software/operating_system/index.md) + - [Networking](./software/operating_system/networking.md) + - [Microservices](./software/microservices/index.md) + - [peach-buttons](./software/microservices/peach-buttons.md) + - [peach-menu](./software/microservices/peach-menu.md) + - [peach-network](./software/microservices/peach-network.md) + - [peach-oled](./software/microservices/peach-oled.md) + - [peach-stats](./software/microservices/peach-stats.md) + - [Web Interface](./software/web_interface.md) + - [Configuration](./software/configuration.md) +- [Contributor's Guide](./contributors_guide.md) +- [Licensing](./licensing.md) diff --git a/src/chapter_3_3_2.md b/src/chapter_3_3_2.md deleted file mode 100644 index 326dd66..0000000 --- a/src/chapter_3_3_2.md +++ /dev/null @@ -1,7 +0,0 @@ -# Web Interface - -[peach-web](https://github.com/peachcloud/peach-web) provides a web interface for monitoring and interacting with the PeachCloud device. This allows administration of the single-board computer (ie. Raspberry Pi) running PeachCloud, as well as the ssb-server and related plugins. - -**Stack** - -The peach-web stack currently consists of [Rocket](https://rocket.rs/) (Rust web framework), [Tera](https://tera.netlify.com/docs/installation/) (Rust template engine inspired by Jinja2 and the Django template language) and [Tachyons](https://tachyons.io/) (functional CSS library for humans). diff --git a/src/chapter_3_4_1.md b/src/chapter_3_4_1.md deleted file mode 100644 index 2363c47..0000000 --- a/src/chapter_3_4_1.md +++ /dev/null @@ -1 +0,0 @@ -# Physical Interface diff --git a/src/chapter_3_4_2.md b/src/chapter_3_4_2.md deleted file mode 100644 index 326dd66..0000000 --- a/src/chapter_3_4_2.md +++ /dev/null @@ -1,7 +0,0 @@ -# Web Interface - -[peach-web](https://github.com/peachcloud/peach-web) provides a web interface for monitoring and interacting with the PeachCloud device. This allows administration of the single-board computer (ie. Raspberry Pi) running PeachCloud, as well as the ssb-server and related plugins. - -**Stack** - -The peach-web stack currently consists of [Rocket](https://rocket.rs/) (Rust web framework), [Tera](https://tera.netlify.com/docs/installation/) (Rust template engine inspired by Jinja2 and the Django template language) and [Tachyons](https://tachyons.io/) (functional CSS library for humans). diff --git a/src/chapter_4.md b/src/contributors_guide.md similarity index 100% rename from src/chapter_4.md rename to src/contributors_guide.md diff --git a/src/chapter_2_2.md b/src/hardware/gpio_pinout.md similarity index 100% rename from src/chapter_2_2.md rename to src/hardware/gpio_pinout.md diff --git a/src/chapter_2.md b/src/hardware/index.md similarity index 100% rename from src/chapter_2.md rename to src/hardware/index.md diff --git a/src/chapter_2_3.md b/src/hardware/physical_interface.md similarity index 100% rename from src/chapter_2_3.md rename to src/hardware/physical_interface.md diff --git a/src/chapter_2_1.md b/src/hardware/requirements.md similarity index 100% rename from src/chapter_2_1.md rename to src/hardware/requirements.md diff --git a/src/chapter_1.md b/src/introduction.md similarity index 75% rename from src/chapter_1.md rename to src/introduction.md index f6e13b3..bca8271 100644 --- a/src/chapter_1.md +++ b/src/introduction.md @@ -2,4 +2,4 @@ PeachCloud is a low-power, lightweight hardware device designed to facilitate peer-to-peer communication across social networks. We aim to return (cloud) computing back into our homes and local communities in a way which fosters increased trust in one another and the socio-technical systems we inhabit. -![peachcloud screen/ interface](./assets/peachcloud.jpg) +![PeachCloud physical interface with PeachCloud logo shown on an OLED display](./assets/peachcloud.jpg) diff --git a/src/chapter_5.md b/src/licensing.md similarity index 100% rename from src/chapter_5.md rename to src/licensing.md diff --git a/src/chapter_3_4.md b/src/software/configuration.md similarity index 100% rename from src/chapter_3_4.md rename to src/software/configuration.md diff --git a/src/chapter_3.md b/src/software/index.md similarity index 100% rename from src/chapter_3.md rename to src/software/index.md diff --git a/src/chapter_3_2.md b/src/software/microservices/index.md similarity index 100% rename from src/chapter_3_2.md rename to src/software/microservices/index.md diff --git a/src/chapter_3_2_1.md b/src/software/microservices/peach-buttons.md similarity index 100% rename from src/chapter_3_2_1.md rename to src/software/microservices/peach-buttons.md diff --git a/src/chapter_3_2_2.md b/src/software/microservices/peach-menu.md similarity index 100% rename from src/chapter_3_2_2.md rename to src/software/microservices/peach-menu.md diff --git a/src/chapter_3_2_3.md b/src/software/microservices/peach-network.md similarity index 100% rename from src/chapter_3_2_3.md rename to src/software/microservices/peach-network.md diff --git a/src/chapter_3_2_4.md b/src/software/microservices/peach-oled.md similarity index 100% rename from src/chapter_3_2_4.md rename to src/software/microservices/peach-oled.md diff --git a/src/chapter_3_2_5.md b/src/software/microservices/peach-stats.md similarity index 100% rename from src/chapter_3_2_5.md rename to src/software/microservices/peach-stats.md diff --git a/src/chapter_3_1.md b/src/software/operating_system/index.md similarity index 100% rename from src/chapter_3_1.md rename to src/software/operating_system/index.md diff --git a/src/chapter_3_1_1.md b/src/software/operating_system/networking.md similarity index 100% rename from src/chapter_3_1_1.md rename to src/software/operating_system/networking.md diff --git a/src/chapter_3_3.md b/src/software/web_interface.md similarity index 100% rename from src/chapter_3_3.md rename to src/software/web_interface.md