Create a getting started page

Caleb-o · Sep 20, 2024 · d96a340 · d96a340
1 parent 8a42ef7
commit d96a340
Show file tree

Hide file tree

Showing 11 changed files with 108 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ This is a basic mdbook to provide examples of using [C3](https://c3-lang.org/).
 
 To build the docs run:
 ```sh
-$ mdbook build --dest-dir docs
+$ mdbook build
 ```
 
 The docs will then be deployed onto github pages on commit.
diff --git a/book.toml b/book.toml
@@ -3,3 +3,6 @@ authors = []
 language = "en"
 multilingual = false
 src = "src"
+
+[build]
+build-dir = "docs"
diff --git a/docs/404.html b/docs/404.html
@@ -89,7 +89,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item expanded "><a href="chapter_1.html"><strong aria-hidden="true">1.</strong> Chapter 1</a></li></ol>
+                <ol class="chapter"><li class="chapter-item expanded affix "><a href="getting_started.html">Getting Started</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                 <div class="sidebar-resize-indicator"></div>

diff --git a/docs/chapter_1.html → docs/getting_started.html b/docs/chapter_1.html → docs/getting_started.html
@@ -3,7 +3,7 @@
     <head>
         <!-- Book generated using mdBook -->
         <meta charset="UTF-8">
-        <title>Chapter 1</title>
+        <title>Getting Started</title>
 
 
         <!-- Custom HTML head -->
@@ -88,7 +88,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item expanded "><a href="chapter_1.html" class="active"><strong aria-hidden="true">1.</strong> Chapter 1</a></li></ol>
+                <ol class="chapter"><li class="chapter-item expanded affix "><a href="getting_started.html" class="active">Getting Started</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                 <div class="sidebar-resize-indicator"></div>
@@ -173,7 +173,29 @@ <h1 class="menu-title"></h1>
 
                 <div id="content" class="content">
                     <main>
-                        <h1 id="chapter-1"><a class="header" href="#chapter-1">Chapter 1</a></h1>
+                        <h1 id="getting-started"><a class="header" href="#getting-started">Getting Started</a></h1>
+<p><a href="https://github.com/Caleb-o/c3-cookbook/stargazers"><img src="https://img.shields.io/github/stars/Caleb-o/c3-cookbook?style=square&amp;color=#30a14e" alt="" /></a></p>
+<p><em>"C3 is a programming language that builds on the syntax and semantics of the C language, with the goal of evolving it while still retaining familiarity for C programmers."</em></p>
+<h2 id="installing-c3"><a class="header" href="#installing-c3">Installing C3</a></h2>
+<p>Use one of the following sources to download or build the C3 compiler from source:</p>
+<ul>
+<li><a href="https://c3-lang.org/">Website</a></li>
+<li><a href="https://github.com/c3lang/c3c/releases">Github Release</a></li>
+<li><a href="https://github.com/c3lang/c3c">More options</a> on their github page, to build from source or use an OS repository</li>
+</ul>
+<h2 id="about-this-book"><a class="header" href="#about-this-book">About this book</a></h2>
+<blockquote>
+<p>[!NOTE]
+This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
+If an example doesn't quite work with 0.6.2, try using the latest compiler.</p>
+</blockquote>
+<p>This was inspired by the <a href="https://github.com/zigcc/zig-cookbook">Zig Cookbook</a> which displays common and more idiomatic ways to use Zig around certain problems. I wanted to create a community driven book, that would do the same for C3. I believe it is something that can help developers pickup C3, as it provides another source to browse.</p>
+<p>I have used new languages where documentation and community driven media was scarce, which made it very hard to get an understanding of the language in a more practical manner. Hopefully this book can help with this issue and get some more people into C3.</p>
+<h3 id="contributing-to-the-book"><a class="header" href="#contributing-to-the-book">Contributing to the book</a></h3>
+<ul>
+<li>Found a typo or example code does not work? <a href="https://github.com/Caleb-o/c3-cookbook/issues/new">Create an issue here</a></li>
+<li>Want to add more examples? <a href="https://github.com/Caleb-o/c3-cookbook">Create a fork</a></li>
+</ul>
 
                     </main>
 

diff --git a/docs/index.html b/docs/index.html
@@ -3,7 +3,7 @@
     <head>
         <!-- Book generated using mdBook -->
         <meta charset="UTF-8">
-        <title>Chapter 1</title>
+        <title>Getting Started</title>
 
 
         <!-- Custom HTML head -->
@@ -88,7 +88,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item expanded "><a href="chapter_1.html" class="active"><strong aria-hidden="true">1.</strong> Chapter 1</a></li></ol>
+                <ol class="chapter"><li class="chapter-item expanded affix "><a href="getting_started.html" class="active">Getting Started</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                 <div class="sidebar-resize-indicator"></div>
@@ -173,7 +173,29 @@ <h1 class="menu-title"></h1>
 
                 <div id="content" class="content">
                     <main>
-                        <h1 id="chapter-1"><a class="header" href="#chapter-1">Chapter 1</a></h1>
+                        <h1 id="getting-started"><a class="header" href="#getting-started">Getting Started</a></h1>
+<p><a href="https://github.com/Caleb-o/c3-cookbook/stargazers"><img src="https://img.shields.io/github/stars/Caleb-o/c3-cookbook?style=square&amp;color=#30a14e" alt="" /></a></p>
+<p><em>"C3 is a programming language that builds on the syntax and semantics of the C language, with the goal of evolving it while still retaining familiarity for C programmers."</em></p>
+<h2 id="installing-c3"><a class="header" href="#installing-c3">Installing C3</a></h2>
+<p>Use one of the following sources to download or build the C3 compiler from source:</p>
+<ul>
+<li><a href="https://c3-lang.org/">Website</a></li>
+<li><a href="https://github.com/c3lang/c3c/releases">Github Release</a></li>
+<li><a href="https://github.com/c3lang/c3c">More options</a> on their github page, to build from source or use an OS repository</li>
+</ul>
+<h2 id="about-this-book"><a class="header" href="#about-this-book">About this book</a></h2>
+<blockquote>
+<p>[!NOTE]
+This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
+If an example doesn't quite work with 0.6.2, try using the latest compiler.</p>
+</blockquote>
+<p>This was inspired by the <a href="https://github.com/zigcc/zig-cookbook">Zig Cookbook</a> which displays common and more idiomatic ways to use Zig around certain problems. I wanted to create a community driven book, that would do the same for C3. I believe it is something that can help developers pickup C3, as it provides another source to browse.</p>
+<p>I have used new languages where documentation and community driven media was scarce, which made it very hard to get an understanding of the language in a more practical manner. Hopefully this book can help with this issue and get some more people into C3.</p>
+<h3 id="contributing-to-the-book"><a class="header" href="#contributing-to-the-book">Contributing to the book</a></h3>
+<ul>
+<li>Found a typo or example code does not work? <a href="https://github.com/Caleb-o/c3-cookbook/issues/new">Create an issue here</a></li>
+<li>Want to add more examples? <a href="https://github.com/Caleb-o/c3-cookbook">Create a fork</a></li>
+</ul>
 
                     </main>
 

diff --git a/docs/print.html b/docs/print.html
@@ -89,7 +89,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item expanded "><a href="chapter_1.html"><strong aria-hidden="true">1.</strong> Chapter 1</a></li></ol>
+                <ol class="chapter"><li class="chapter-item expanded affix "><a href="getting_started.html">Getting Started</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                 <div class="sidebar-resize-indicator"></div>
@@ -174,7 +174,29 @@ <h1 class="menu-title"></h1>
 
                 <div id="content" class="content">
                     <main>
-                        <h1 id="chapter-1"><a class="header" href="#chapter-1">Chapter 1</a></h1>
+                        <h1 id="getting-started"><a class="header" href="#getting-started">Getting Started</a></h1>
+<p><a href="https://github.com/Caleb-o/c3-cookbook/stargazers"><img src="https://img.shields.io/github/stars/Caleb-o/c3-cookbook?style=square&amp;color=#30a14e" alt="" /></a></p>
+<p><em>"C3 is a programming language that builds on the syntax and semantics of the C language, with the goal of evolving it while still retaining familiarity for C programmers."</em></p>
+<h2 id="installing-c3"><a class="header" href="#installing-c3">Installing C3</a></h2>
+<p>Use one of the following sources to download or build the C3 compiler from source:</p>
+<ul>
+<li><a href="https://c3-lang.org/">Website</a></li>
+<li><a href="https://github.com/c3lang/c3c/releases">Github Release</a></li>
+<li><a href="https://github.com/c3lang/c3c">More options</a> on their github page, to build from source or use an OS repository</li>
+</ul>
+<h2 id="about-this-book"><a class="header" href="#about-this-book">About this book</a></h2>
+<blockquote>
+<p>[!NOTE]
+This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
+If an example doesn't quite work with 0.6.2, try using the latest compiler.</p>
+</blockquote>
+<p>This was inspired by the <a href="https://github.com/zigcc/zig-cookbook">Zig Cookbook</a> which displays common and more idiomatic ways to use Zig around certain problems. I wanted to create a community driven book, that would do the same for C3. I believe it is something that can help developers pickup C3, as it provides another source to browse.</p>
+<p>I have used new languages where documentation and community driven media was scarce, which made it very hard to get an understanding of the language in a more practical manner. Hopefully this book can help with this issue and get some more people into C3.</p>
+<h3 id="contributing-to-the-book"><a class="header" href="#contributing-to-the-book">Contributing to the book</a></h3>
+<ul>
+<li>Found a typo or example code does not work? <a href="https://github.com/Caleb-o/c3-cookbook/issues/new">Create an issue here</a></li>
+<li>Want to add more examples? <a href="https://github.com/Caleb-o/c3-cookbook">Create a fork</a></li>
+</ul>
 
                     </main>
 

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/searchindex.json b/docs/searchindex.json
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -1,3 +1,3 @@
 # Summary
 
-- [Chapter 1](./chapter_1.md)
+[Getting Started](getting_started.md)
diff --git a/src/chapter_1.md b/src/chapter_1.md
diff --git a/src/getting_started.md b/src/getting_started.md
@@ -0,0 +1,26 @@
+# Getting Started
+
+[![](https://img.shields.io/github/stars/Caleb-o/c3-cookbook?style=square&color=#30a14e)](https://github.com/Caleb-o/c3-cookbook/stargazers)
+
+*"C3 is a programming language that builds on the syntax and semantics of the C language, with the goal of evolving it while still retaining familiarity for C programmers."*
+
+## Installing C3
+
+Use one of the following sources to download or build the C3 compiler from source:
+- [Website](https://c3-lang.org/)
+- [Github Release](https://github.com/c3lang/c3c/releases)
+- [More options](https://github.com/c3lang/c3c) on their github page, to build from source or use an OS repository
+
+## About this book
+
+> [!NOTE]
+> This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
+> If an example doesn't quite work with 0.6.2, try using the latest compiler.
+
+This was inspired by the [Zig Cookbook](https://github.com/zigcc/zig-cookbook) which displays common and more idiomatic ways to use Zig around certain problems. I wanted to create a community driven book, that would do the same for C3. I believe it is something that can help developers pickup C3, as it provides another source to browse. 
+
+I have used new languages where documentation and community driven media was scarce, which made it very hard to get an understanding of the language in a more practical manner. Hopefully this book can help with this issue and get some more people into C3.
+
+### Contributing to the book
+- Found a typo or example code does not work? [Create an issue here](https://github.com/Caleb-o/c3-cookbook/issues/new)
+- Want to add more examples? [Create a fork](https://github.com/Caleb-o/c3-cookbook)