From 674c61dce57badb85bf671a308262c732796c590 Mon Sep 17 00:00:00 2001 From: Mark Kremer Date: Sun, 20 Oct 2024 21:58:03 +0200 Subject: [PATCH] Refactor docs in preparation for docgen --- docs/{Home.md => Tutorial/01. Home.md} | 0 docs/{Hello,-Beep!.md => Tutorial/02. Hello, Beep!.md} | 2 ++ .../03. Composing and Controlling.md} | 2 ++ .../04. Making Own Streamers.md} | 2 ++ .../04. To Buffer, or Not To Buffer.md} | 2 ++ docs/_Sidebar.md | 6 ------ 6 files changed, 8 insertions(+), 6 deletions(-) rename docs/{Home.md => Tutorial/01. Home.md} (100%) rename docs/{Hello,-Beep!.md => Tutorial/02. Hello, Beep!.md} (99%) rename docs/{Composing-and-controlling.md => Tutorial/03. Composing and Controlling.md} (99%) rename docs/{Making-own-streamers.md => Tutorial/04. Making Own Streamers.md} (99%) rename docs/{To-buffer,-or-not-to-buffer,-that-is-the-question.md => Tutorial/04. To Buffer, or Not To Buffer.md} (98%) delete mode 100644 docs/_Sidebar.md diff --git a/docs/Home.md b/docs/Tutorial/01. Home.md similarity index 100% rename from docs/Home.md rename to docs/Tutorial/01. Home.md diff --git a/docs/Hello,-Beep!.md b/docs/Tutorial/02. Hello, Beep!.md similarity index 99% rename from docs/Hello,-Beep!.md rename to docs/Tutorial/02. Hello, Beep!.md index 6f4e8f1..2cd1a5f 100644 --- a/docs/Hello,-Beep!.md +++ b/docs/Tutorial/02. Hello, Beep!.md @@ -1,3 +1,5 @@ +# Hello, Beep! + Welcome to the Beep tutorial! In this part, we'll learn how to load a song, initialize the speaker, and wake up your neighbors. The first thing we obviously need is the [Beep library](https://github.com/gopxl/beep/) (I expect you have the Go programming language installed), which you can install with this command: diff --git a/docs/Composing-and-controlling.md b/docs/Tutorial/03. Composing and Controlling.md similarity index 99% rename from docs/Composing-and-controlling.md rename to docs/Tutorial/03. Composing and Controlling.md index 703227d..4c941b7 100644 --- a/docs/Composing-and-controlling.md +++ b/docs/Tutorial/03. Composing and Controlling.md @@ -1,3 +1,5 @@ +# Composing and Controlling + In this part, we'll learn how to compose new, more complex streamers out of simpler ones and how to control their playback. We'll start roughly where we left off in the previous part (excluding the resampling). If you don't have the code, here it is: diff --git a/docs/Making-own-streamers.md b/docs/Tutorial/04. Making Own Streamers.md similarity index 99% rename from docs/Making-own-streamers.md rename to docs/Tutorial/04. Making Own Streamers.md index 27195d1..b51f69e 100644 --- a/docs/Making-own-streamers.md +++ b/docs/Tutorial/04. Making Own Streamers.md @@ -1,3 +1,5 @@ +# Making own streamers + Beep offers a lot of pre-made streamers, but sometimes that's not enough. Fortunately, making new ones isn't very hard and in this part, we'll learn just that. So, what's a streamer? It's this interface: diff --git a/docs/To-buffer,-or-not-to-buffer,-that-is-the-question.md b/docs/Tutorial/04. To Buffer, or Not To Buffer.md similarity index 98% rename from docs/To-buffer,-or-not-to-buffer,-that-is-the-question.md rename to docs/Tutorial/04. To Buffer, or Not To Buffer.md index cdc5dfd..4a513ec 100644 --- a/docs/To-buffer,-or-not-to-buffer,-that-is-the-question.md +++ b/docs/Tutorial/04. To Buffer, or Not To Buffer.md @@ -1,3 +1,5 @@ +# To buffer, or not to buffer, that is the question + The root data source of all audio we've worked with so far was an audio file. The audio file had to be open the whole time its content was being played over the speaker. Obviously, this isn't always desirable. A good example is a gunshot sound effect in an action game. It's a small file, there's no reason to stream it directly from the disk. It's much better to have it loaded in memory. Furthermore, there may be gunshots all over the place. Decoding a file gives us only one streamer, which limits us to only one gunshot sound playing at any moment. We could open the file multiple times, but you can surely see that's a wrong way to do it. In this part, we'll learn how to load a sound to memory and then stream it from there. diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md deleted file mode 100644 index 7712de5..0000000 --- a/docs/_Sidebar.md +++ /dev/null @@ -1,6 +0,0 @@ -### [Home](https://github.com/gopxl/beep/wiki) - -### [Hello, Beep!](https://github.com/gopxl/beep/wiki/Hello,-Beep!) -### [Composing and controlling](https://github.com/gopxl/beep/wiki/Composing-and-controlling) -### [To buffer, or not to buffer, that is the question](https://github.com/gopxl/beep/wiki/To-buffer,-or-not-to-buffer,-that-is-the-question) -### [Making own streamers](https://github.com/gopxl/beep/wiki/Making-own-streamers) \ No newline at end of file