diff --git a/src/SUMMARY.md b/src/SUMMARY.md index f366346..005c558 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,18 +1,28 @@ # Summary -[Getting Started](getting_started.md) + +# Foreword + +- [Getting Started](getting_started.md) --- +# A Glimpse of C3 + - [General Overview](general/general.md) - [Hello World!](general/hello_world.md) - [Modules and Generics](general/modules.md) --- -- [Examples](examples.md) +# Concepts and Projects + +- [Concepts](concepts.md) - [Using stdio]() - [Filesystem]() - - [Echo Client/Server]() - - [Calculator Evaluator](./projects/calculator.md) - - [Writing an Allocator]() \ No newline at end of file + - [Compiletime, Macros and Reflection]() + +- [Projects](projects.md) + - [Echo TCP Client/Server]() + - [Writing an Allocator]() + - [Calculator Evaluator](./projects/calculator.md) \ No newline at end of file diff --git a/src/concepts.md b/src/concepts.md new file mode 100644 index 0000000..3820413 --- /dev/null +++ b/src/concepts.md @@ -0,0 +1,12 @@ +# Concepts + +> 🚧 Not all topics are written yet and are a work in progress + +From here, we will be covering specific topics in C3. These can range from common operations, to data structures and standard library usage. This is to give more examples on how these features and functions are used. This is in no way a deep dive into these, but enough to hopefully kickstart learning C3's ecosystem. + +> For most of these examples, we will slowly go over each part and then do a code dump at the end. If you're using a project to run these examples, you can use `c3c run` or `c3c build`. Otherwise you can compile and run a file with `c3c compile-run --run-once .c3`. + +Topics we will cover: +- [Using stdio](): reading and writing to the console with stdio +- [The Filesystem](): reading and writing files +- [Compiletime, Macros and Reflection]() \ No newline at end of file diff --git a/src/examples.md b/src/examples.md index 127ebcc..c3b59da 100644 --- a/src/examples.md +++ b/src/examples.md @@ -6,6 +6,4 @@ From here, we will be covering specific topics in C3. These can range from commo Topics we will cover: - [Using stdio](): reading and writing to the console with stdio -- [The Filesystem](): reading and writing files -- [TCP Server](): a basic echo TCP client and server -- [Evaluating a basic expression](./projects/calculator.md): create a small parser and evaluator for a calculator \ No newline at end of file +- [The Filesystem](): reading and writing files \ No newline at end of file diff --git a/src/projects.md b/src/projects.md new file mode 100644 index 0000000..04b1586 --- /dev/null +++ b/src/projects.md @@ -0,0 +1,12 @@ +# Projects + +> 🚧 Not all topics are written yet and are a work in progress + +This is a showcase of small projects you could create in C3. These examples are meant to serve as a "real world" usage of the language. + +> For most of these examples, we will slowly go over each part and then do a code dump at the end. If you're using a project to run these examples, you can use `c3c run` or `c3c build`. Otherwise you can compile and run a file with `c3c compile-run --run-once .c3`. + +Projects: +- [TCP Server](): a basic echo TCP client and server +- [Writing an Allocator](): write a basic allocator that you can use to handle memory +- [Evaluating a basic expression](./projects/calculator.md): create a small parser and evaluator for a calculator \ No newline at end of file