Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add TOC & created install.md #82

Merged
merged 4 commits into from
May 26, 2024
Merged

Conversation

hendriknielaender
Copy link
Owner

@hendriknielaender hendriknielaender commented May 25, 2024

Enhance README and Add installation documentation

  • Added a Table of Contents (TOC) for better navigation.
  • Moved detailed installation instructions to docs/install.md.

@hendriknielaender hendriknielaender changed the title chore: add TOC chore: add TOC & created install.md May 25, 2024
@hendriknielaender hendriknielaender marked this pull request as ready for review May 25, 2024 21:41
docs/install.md Outdated

const exe = b.addExecutable(.{
.name = "test",
.root_source_file = .{ .path = "src/main.zig" },
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you might wanna change this to the b.path(...) syntax ^^


```zig
const zbench = @import("zbench");
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could also add a "further reading"; for instance https://ziglang.org/learn/build-system/ and https://ziggit.dev/t/build-system-tricks/ are quite useful I think

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, makes sense 👍

```zig
const zbench = @import("zbench");
```
## Content
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great!

@hendriknielaender hendriknielaender merged commit 3c84653 into main May 26, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants