initial book skeleton

overdrivenpotato · Dec 30, 2023 · f2117e5 · f2117e5
1 parent 693423a
commit f2117e5
Show file tree

Hide file tree

Showing 33 changed files with 70 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
-target
+book/book
+target/
 Cargo.lock
diff --git a/book.toml b/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["Marko Mijalkovic", "Paul Sajna"]
+language = "en"
+multilingual = false
+src = "src"
+title = "Rust-PSP Book"
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -0,0 +1,32 @@
+# Summary
+
+[Welcome](welcome.md)
+
+- [Introduction](intro.md)
+  - [What is Rust-PSP and its significance in PSP development?](intro/what_is.md)
+  - [Hardware Overview](intro/hw_overview.md)
+- [Setup](setup.md)
+  - [Installing Rust and Rust-PSP tools](setup/install.md)
+  - [Debugging (Emulator and Hardware)](setup/debug.md)
+- [Hello World](hello_world.md)
+  - [Understanding project structure](hello/structure.md)
+  - [Writing your first Rust-PSP application](hello/writing_hello_world.md)
+- [Logging with stdio](stdio.md)
+- [Input](input.md)
+  - [Introduction to controls and input handling](input/intro.md)
+  - [Modifying your Hello World to respond to button presses](input/hello.md)
+- [Framebuffer](framebuffer.md)
+  - [Introduction to the PSP's framebuffer](framebuffer/intro.md)
+  - [Raw framebuffer writes from code](framebuffer/raw.md)
+  - [Embedded Graphics](framebuffer/emb-g.md)
+- [Introduction to Hardware-Accelerated graphics with sceGu](scegu.md)
+  - [Understanding sceGu and it's role in PSP graphics](scegu/understanding.md)
+  - [Setting up sceGu and understanding the basics of PSP graphics](scegu/setup.md)
+- [Rendering a Triangle](triangle.md)
+- [Complex 3D Shapes](complex_3d.md)
+- [Integrating Sound](sound.md)
+- [VFPU assembly](vfpu.md)
+- [Networking](networking.md)
+- [Final Project](final_project.md)
+- [Next Steps](next_steps.md)
+
diff --git a/book/src/complex_3d.md b/book/src/complex_3d.md
@@ -0,0 +1 @@
+# Complex 3D Shapes
diff --git a/book/src/final_project.md b/book/src/final_project.md
@@ -0,0 +1 @@
+# Final Project
diff --git a/book/src/framebuffer.md b/book/src/framebuffer.md
@@ -0,0 +1 @@
+# Framebuffer
diff --git a/book/src/framebuffer/emb-g.md b/book/src/framebuffer/emb-g.md
@@ -0,0 +1 @@
+# Embedded Graphics
diff --git a/book/src/framebuffer/intro.md b/book/src/framebuffer/intro.md
@@ -0,0 +1 @@
+# Introduction to the PSP's framebuffer
diff --git a/book/src/framebuffer/raw.md b/book/src/framebuffer/raw.md
@@ -0,0 +1 @@
+# Raw framebuffer writes from code
diff --git a/book/src/hello/structure.md b/book/src/hello/structure.md
@@ -0,0 +1 @@
+# Understanding project structure
diff --git a/book/src/hello/writing_hello_world.md b/book/src/hello/writing_hello_world.md
@@ -0,0 +1 @@
+# Writing your first Rust-PSP application
diff --git a/book/src/hello_world.md b/book/src/hello_world.md
@@ -0,0 +1 @@
+# Hello World
diff --git a/book/src/hw_overview.md b/book/src/hw_overview.md
@@ -0,0 +1 @@
+# Hardware Overview
diff --git a/book/src/input.md b/book/src/input.md
@@ -0,0 +1 @@
+# Input
diff --git a/book/src/input/hello.md b/book/src/input/hello.md
@@ -0,0 +1 @@
+# Modifying your Hello World to respond to button presses
diff --git a/book/src/input/intro.md b/book/src/input/intro.md
@@ -0,0 +1 @@
+# Introduction to controls and input handling
diff --git a/book/src/intro.md b/book/src/intro.md
@@ -0,0 +1 @@
+# Introduction
diff --git a/book/src/intro/hw_overview.md b/book/src/intro/hw_overview.md
@@ -0,0 +1 @@
+# Hardware Overview
diff --git a/book/src/intro/what_is.md b/book/src/intro/what_is.md
@@ -0,0 +1 @@
+# What is Rust-PSP and its significance in PSP development?
diff --git a/book/src/networking.md b/book/src/networking.md
@@ -0,0 +1 @@
+# Networking
diff --git a/book/src/next_steps.md b/book/src/next_steps.md
@@ -0,0 +1 @@
+# Next Steps
diff --git a/book/src/scegu.md b/book/src/scegu.md
@@ -0,0 +1 @@
+# Introduction to Hardware-Accelerated graphics with sceGu
diff --git a/book/src/scegu/setup.md b/book/src/scegu/setup.md
@@ -0,0 +1 @@
+# Setting up sceGu and understanding the basics of PSP graphics
diff --git a/book/src/scegu/understanding.md b/book/src/scegu/understanding.md
@@ -0,0 +1 @@
+# Understanding sceGu and it's role in PSP graphics
diff --git a/book/src/setup.md b/book/src/setup.md
@@ -0,0 +1 @@
+# Setup
diff --git a/book/src/setup/debug.md b/book/src/setup/debug.md
@@ -0,0 +1 @@
+# Debugging (Emulator and Hardware)
diff --git a/book/src/setup/install.md b/book/src/setup/install.md
@@ -0,0 +1 @@
+# Installing Rust and Rust-PSP tools
diff --git a/book/src/sound.md b/book/src/sound.md
@@ -0,0 +1 @@
+# Integrating Sound
diff --git a/book/src/stdio.md b/book/src/stdio.md
@@ -0,0 +1 @@
+# Logging with stdio
diff --git a/book/src/triangle.md b/book/src/triangle.md
@@ -0,0 +1 @@
+# Rendering a Triangle
diff --git a/book/src/vfpu.md b/book/src/vfpu.md
@@ -0,0 +1 @@
+# VFPU assembly
diff --git a/book/src/welcome.md b/book/src/welcome.md
@@ -0,0 +1 @@
+# Welcome
diff --git a/book/src/what_is.md b/book/src/what_is.md
@@ -0,0 +1 @@
+# What is Rust-PSP and its significance in PSP development?