From f2117e53c057ee61fcb927812673a1f6c4a5f7fe Mon Sep 17 00:00:00 2001 From: Paul Sajna Date: Sat, 30 Dec 2023 10:38:15 -0800 Subject: [PATCH] initial book skeleton --- .gitignore | 3 ++- book.toml | 6 +++++ book/src/SUMMARY.md | 32 +++++++++++++++++++++++++++ book/src/complex_3d.md | 1 + book/src/final_project.md | 1 + book/src/framebuffer.md | 1 + book/src/framebuffer/emb-g.md | 1 + book/src/framebuffer/intro.md | 1 + book/src/framebuffer/raw.md | 1 + book/src/hello/structure.md | 1 + book/src/hello/writing_hello_world.md | 1 + book/src/hello_world.md | 1 + book/src/hw_overview.md | 1 + book/src/input.md | 1 + book/src/input/hello.md | 1 + book/src/input/intro.md | 1 + book/src/intro.md | 1 + book/src/intro/hw_overview.md | 1 + book/src/intro/what_is.md | 1 + book/src/networking.md | 1 + book/src/next_steps.md | 1 + book/src/scegu.md | 1 + book/src/scegu/setup.md | 1 + book/src/scegu/understanding.md | 1 + book/src/setup.md | 1 + book/src/setup/debug.md | 1 + book/src/setup/install.md | 1 + book/src/sound.md | 1 + book/src/stdio.md | 1 + book/src/triangle.md | 1 + book/src/vfpu.md | 1 + book/src/welcome.md | 1 + book/src/what_is.md | 1 + 33 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 book.toml create mode 100644 book/src/SUMMARY.md create mode 100644 book/src/complex_3d.md create mode 100644 book/src/final_project.md create mode 100644 book/src/framebuffer.md create mode 100644 book/src/framebuffer/emb-g.md create mode 100644 book/src/framebuffer/intro.md create mode 100644 book/src/framebuffer/raw.md create mode 100644 book/src/hello/structure.md create mode 100644 book/src/hello/writing_hello_world.md create mode 100644 book/src/hello_world.md create mode 100644 book/src/hw_overview.md create mode 100644 book/src/input.md create mode 100644 book/src/input/hello.md create mode 100644 book/src/input/intro.md create mode 100644 book/src/intro.md create mode 100644 book/src/intro/hw_overview.md create mode 100644 book/src/intro/what_is.md create mode 100644 book/src/networking.md create mode 100644 book/src/next_steps.md create mode 100644 book/src/scegu.md create mode 100644 book/src/scegu/setup.md create mode 100644 book/src/scegu/understanding.md create mode 100644 book/src/setup.md create mode 100644 book/src/setup/debug.md create mode 100644 book/src/setup/install.md create mode 100644 book/src/sound.md create mode 100644 book/src/stdio.md create mode 100644 book/src/triangle.md create mode 100644 book/src/vfpu.md create mode 100644 book/src/welcome.md create mode 100644 book/src/what_is.md diff --git a/.gitignore b/.gitignore index a9d37c56..38b83874 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ -target +book/book +target/ Cargo.lock diff --git a/book.toml b/book.toml new file mode 100644 index 00000000..59b6e699 --- /dev/null +++ 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 new file mode 100644 index 00000000..d54174ef --- /dev/null +++ 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 new file mode 100644 index 00000000..4b968a5c --- /dev/null +++ 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 new file mode 100644 index 00000000..d3020113 --- /dev/null +++ b/book/src/final_project.md @@ -0,0 +1 @@ +# Final Project diff --git a/book/src/framebuffer.md b/book/src/framebuffer.md new file mode 100644 index 00000000..5eb5b5e6 --- /dev/null +++ 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 new file mode 100644 index 00000000..c82a1669 --- /dev/null +++ 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 new file mode 100644 index 00000000..6c2b8b3b --- /dev/null +++ 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 new file mode 100644 index 00000000..4ba44132 --- /dev/null +++ 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 new file mode 100644 index 00000000..4698a320 --- /dev/null +++ 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 new file mode 100644 index 00000000..1d69ee51 --- /dev/null +++ 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 new file mode 100644 index 00000000..29658341 --- /dev/null +++ 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 new file mode 100644 index 00000000..7daa23f4 --- /dev/null +++ b/book/src/hw_overview.md @@ -0,0 +1 @@ +# Hardware Overview diff --git a/book/src/input.md b/book/src/input.md new file mode 100644 index 00000000..135b6af3 --- /dev/null +++ b/book/src/input.md @@ -0,0 +1 @@ +# Input diff --git a/book/src/input/hello.md b/book/src/input/hello.md new file mode 100644 index 00000000..91f91c1d --- /dev/null +++ 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 new file mode 100644 index 00000000..3db98fce --- /dev/null +++ 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 new file mode 100644 index 00000000..e10b99d0 --- /dev/null +++ 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 new file mode 100644 index 00000000..7daa23f4 --- /dev/null +++ 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 new file mode 100644 index 00000000..0baf830e --- /dev/null +++ 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 new file mode 100644 index 00000000..048579a4 --- /dev/null +++ b/book/src/networking.md @@ -0,0 +1 @@ +# Networking diff --git a/book/src/next_steps.md b/book/src/next_steps.md new file mode 100644 index 00000000..188c9c76 --- /dev/null +++ b/book/src/next_steps.md @@ -0,0 +1 @@ +# Next Steps diff --git a/book/src/scegu.md b/book/src/scegu.md new file mode 100644 index 00000000..5d64215c --- /dev/null +++ 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 new file mode 100644 index 00000000..6041d914 --- /dev/null +++ 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 new file mode 100644 index 00000000..98bb99dd --- /dev/null +++ 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 new file mode 100644 index 00000000..feae8cb5 --- /dev/null +++ b/book/src/setup.md @@ -0,0 +1 @@ +# Setup diff --git a/book/src/setup/debug.md b/book/src/setup/debug.md new file mode 100644 index 00000000..1831df7c --- /dev/null +++ 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 new file mode 100644 index 00000000..302013f6 --- /dev/null +++ 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 new file mode 100644 index 00000000..6b09417b --- /dev/null +++ b/book/src/sound.md @@ -0,0 +1 @@ +# Integrating Sound diff --git a/book/src/stdio.md b/book/src/stdio.md new file mode 100644 index 00000000..905be74a --- /dev/null +++ b/book/src/stdio.md @@ -0,0 +1 @@ +# Logging with stdio diff --git a/book/src/triangle.md b/book/src/triangle.md new file mode 100644 index 00000000..2d12d963 --- /dev/null +++ b/book/src/triangle.md @@ -0,0 +1 @@ +# Rendering a Triangle diff --git a/book/src/vfpu.md b/book/src/vfpu.md new file mode 100644 index 00000000..a33a08e7 --- /dev/null +++ b/book/src/vfpu.md @@ -0,0 +1 @@ +# VFPU assembly diff --git a/book/src/welcome.md b/book/src/welcome.md new file mode 100644 index 00000000..f82f58ec --- /dev/null +++ b/book/src/welcome.md @@ -0,0 +1 @@ +# Welcome diff --git a/book/src/what_is.md b/book/src/what_is.md new file mode 100644 index 00000000..0baf830e --- /dev/null +++ b/book/src/what_is.md @@ -0,0 +1 @@ +# What is Rust-PSP and its significance in PSP development?