Skip to content

Commit

Permalink
Move coverage note to top of modules page
Browse files Browse the repository at this point in the history
  • Loading branch information
Caleb-o committed Sep 21, 2024
1 parent 867cd5a commit 41eebd1
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
5 changes: 3 additions & 2 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@

- [General Overview](general/general.md)
- [Hello World!](general/hello_world.md)
- [Modules](general/modules.md)
- [Modules and Generics](general/modules.md)

---

- [Examples](examples.md)
- [Using stdio]()
- [Filesystem]()
- [Echo Client/Server]()
- [Calculator Evaluator](./projects/calculator.md)
- [Calculator Evaluator](./projects/calculator.md)
- [Writing an Allocator]()
4 changes: 3 additions & 1 deletion src/general/modules.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
5 changes: 2 additions & 3 deletions src/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 41eebd1

Please sign in to comment.