Skip to content

Commit

Permalink
add intro
Browse files Browse the repository at this point in the history
  • Loading branch information
jiacai2050 committed Dec 10, 2023
1 parent 793d30e commit 1cabd73
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 22 deletions.
22 changes: 0 additions & 22 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
26 changes: 26 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Zig Cookbook

[![](https://github.com/zigcc/zig-cookbook/actions/workflows/ci.yml/badge.svg)](https://github.com/zigcc/zig-cookbook/actions/workflows/ci.yml)
[![](https://github.com/zigcc/zig-cookbook/actions/workflows/pages.yml/badge.svg)](https://github.com/zigcc/zig-cookbook/actions/workflows/pages.yml)

[Zig cookbook](https://zigcc.github.io/zig-cookbook/) is a collection of simple Zig programs that demonstrate good practices to accomplish common programming tasks.

# How to run

Each tips is accompanied by an illustrative example named after its corresponding sequence number. These examples can be executed using the command `zig build run-{number}`, or `zig build run-all` to execute all.

> Currently 0.11.0 is required to run those examples.
# Contributing

Anyone is welcome to contribute, and this project use [prettier](https://prettier.io/) to format markdown files, make sure to execute `make lint` before open new PR.

# Acknowledgment

When working on zig-cookbook, we benefit a lot from several similar projects, thanks for their awesome work.

- [Rust Cookbook](https://github.com/rust-lang-nursery/rust-cookbook)

# License

[CC BY-NC-ND 4.0 DEED](https://creativecommons.org/licenses/by-nc-nd/4.0/)
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Summary

- [Introduction](./README.md)
- [File System]()
- [Read file line by line](./01-01-read-file-line-by-line.md)
- [Mmap file](./01-02-mmap-file.md)

0 comments on commit 1cabd73

Please sign in to comment.