From 41eebd19f5e46ea5bc7f54bec7e11fcd07d6742f Mon Sep 17 00:00:00 2001 From: Caleb-o Date: Sun, 22 Sep 2024 03:15:31 +1000 Subject: [PATCH] Move coverage note to top of modules page --- src/SUMMARY.md | 5 +++-- src/general/modules.md | 4 +++- src/getting_started.md | 5 ++--- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index ed3c01e..f366346 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -6,7 +6,7 @@ - [General Overview](general/general.md) - [Hello World!](general/hello_world.md) - - [Modules](general/modules.md) + - [Modules and Generics](general/modules.md) --- @@ -14,4 +14,5 @@ - [Using stdio]() - [Filesystem]() - [Echo Client/Server]() - - [Calculator Evaluator](./projects/calculator.md) \ No newline at end of file + - [Calculator Evaluator](./projects/calculator.md) + - [Writing an Allocator]() \ No newline at end of file diff --git a/src/general/modules.md b/src/general/modules.md index c692379..8762d37 100644 --- a/src/general/modules.md +++ b/src/general/modules.md @@ -1,6 +1,8 @@ # Modules -[Modules](https://c3-lang.org/references/docs/modules/) in C3 are quite interesting. Every file must start with a module declaration, as such `module mymodule`. A module is a container that namespaces our code. Later on, I will show how modules are our gateway into using generics. This is not full coverage on modules, but a glimpse to understand how to use them. +> This is not full coverage of what modules are or do. If you want to learn more, visit [the guide](https://c3-lang.org/references/docs/modules/). + +Modules in C3 are quite interesting. Every file must start with a module declaration, as such `module mymodule`. A module is a container that namespaces our code. Later on, I will show how modules are our gateway into using generics. Here's a list of things that will be covered: - [Using modules and its properties](#using-modules) diff --git a/src/getting_started.md b/src/getting_started.md index 32dee16..ad1d967 100644 --- a/src/getting_started.md +++ b/src/getting_started.md @@ -6,11 +6,10 @@ ## About this book - -> This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2. +> This 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](https://github.com/c3lang/c3c/releases/tag/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. +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.