Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pedropark99/zig-book

An open, technical and introductory book for the Zig programming language
https://github.com/pedropark99/zig-book

book course programming programming-language tutorial tutorial-course zig ziglang

Last synced: about 12 hours ago
JSON representation

An open, technical and introductory book for the Zig programming language

Awesome Lists containing this project

README 

        
# Introduction to Zig






Hey! This is the official repository for the book "Introduction to Zig: a project-based book", written by Pedro Duarte Faria.

To know more about the book, checkout the [About this book](#about-this-book) section below.

You can read the current version of the book in your web browser: .



The book is built using the publishing system [Quarto](https://quarto.org)

in conjunction with a little bit of R code (`zig_engine.R`), that is responsible for calling

the Zig compiler to compile and run the Zig code examples.



## Support the project!



If you like this project, and you want to support it, you can buy an eBook or a physical copy

of the book on Amazon:



### Sending donations directly



You can also donate some amount directly to the author of the project via:



- PayPal Donation.

- Revolut.



These are good ways to support directly the author of the project, which helps to foster

more contents like this, and it makes possible for the author to keep writing helpful tools and

materials for the community.



### PayPal



[![PayPal](https://img.shields.io/badge/PayPal-003087?logo=paypal&logoColor=fff)](https://www.paypal.com/donate/?business=D58J5LFEERC3N&no_recurring=0&item_name=These+donations+make+it+possible+for+me+to+continue+writing+new+and+useful+content+for+our+community%F0%9F%98%89+Thank+you%21%E2%9D%A4%EF%B8%8F%F0%9F%A5%B3&currency_code=USD)



### Revolut



You can send money via Swift Payment with the following bank and Swift details:



```

Recipient: Pedro Duarte Faria

BIC/SWIFT Code: REVOSGS2

Account number: 6124512226

Name and address of the bank: Revolut Technologies Singapore Pte. Ltd, 6 Battery Road, Floor 6-01, 049909, Singapore, Singapore

Corresponding BIC: CHASGB2L

```



If you do have a Revolut account, you can scan the following QR code:



## About this book



This is an open (i.e. it is open-source), technical and introductory book for the [Zig programming language](https://ziglang.org/),

which is a new general purpose, and low-level programming language for building optimal and robust software.



Official repository of the book: .



This book is designed for both beginners and experienced developers. It explores the exciting world of Zig through small

and simple projects (in a similar style to the famous "Python Crash Course" book from Eric Matthes).

Some of these projects are: a Base64 encoder/decoder, a HTTP Server and an image filter.



As you work through the book, you will learn:



- The syntax of the language, and how it compares to C, C++ and Rust.

- Data structures, memory allocators, filesystem and I/O.

- Optionals as a new paradigm to handle nullability.

- How to test and debug a Zig application.

- Errors as values, and how to handle them.

- How to build C and Zig code with the build system that is embedded into the language.

- Zig interoperability with C.

- Parallelism with threads and SIMD.

- And more.



## How to build the book



This book depends on the three main pieces of software:



1. The [Zig compiler](https://ziglang.org/download/), which is responsible for compiling most of the code examples exposed in the book.

2. The [R programming language](https://cran.r-project.org/), which provides some useful tools to collect the code examples exposed across the book, and send them to the zig compiler to be compiled and executed, and also, collect the results back to include them in the book.

3. The [Quarto publishing system](https://quarto.org/docs/get-started/), which provides the useful tools to compile the book, creating internal links, references, a chapters structure, the HTML content of the book, etc.



So, you first need to install these three pieces of software in your current machine.

You can find instructions on how to install these pieces of software by clicking in the above hyperlinks.



### Install R packages



After you installed the three pieces of software listed above, you should run the `dependencies.R` R script, to install

some R packages that are used across the book. Just run the command below in your terminal, and you should be fine.



OBS: If you are on Linux or MacOS, this command will probably take some time to run, because every single dependency get's built from source.

In Windows, this usually doesn't take that long because pre-built binaries are usually available.



```bash

Rscript dependencies.R

```



### Render the book



If you installed Quarto correctly in your computer

, you should be able to build the book by simply executing

the following command in the terminal.



```bash

quarto render

```



### How the Zig compiler is found



Some R code (`zig_engine.R`) is used to collect the Zig code examples

found across the book, and send them to the Zig compiler, so that they

can be compiled and executed.



But in order to do that, this R code needs to find the Zig compiler installed

in your machine. This search process is done in two stages.

First, it uses the [`Sys.which()` function](https://www.rdocumentation.org/packages/base/versions/3.6.2/topics/Sys.which)

to find the path to the Zig compiler in your computer, which is just a R interface to the `which` command line tool.



This is a fast and easy approach, but, it doesn't work in all situations, specially if

your Zig compiler is not installed in a "standard location" in your computer. That is

why, a second strategy is applied, which is to search through the PATH environment variable.



It gets the value of your PATH environment variable, and iterates through the directories listed

in this variable, trying to find the Zig compiler in one of them. This approach is much

slower than the first one, but is more garanteed to work.



## License



Copyright © 2024 Pedro Duarte Faria. This book is licensed by the CC-BY 4.0 Creative Commons Attribution 4.0 International Public License.



Creative Commons License