Skip to content
This repository has been archived by the owner on Jul 23, 2024. It is now read-only.

Tentative fix for Getting Started page not working #15

Closed
Closed
6 changes: 3 additions & 3 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ jobs:
steps:
- uses: actions/checkout@v2
with:
submodules: 'recursive'
submodules: "recursive"
- name: Setup Zig
uses: goto-bus-stop/setup-zig@v2
with:
version: master
version: 0.13.0
- name: Render website
run: |
zig build
Expand All @@ -34,5 +34,5 @@ jobs:
Heya!
You can check out a preview of your PR at [staging.microzig.tech/pulls/${{ github.event.number }}](https://staging.microzig.tech/pulls/${{ github.event.number }}/)!
repo-token: ${{ secrets.GITHUB_TOKEN }}
repo-token-user-login: 'github-actions[bot]' # The user.login for temporary GitHub tokens
repo-token-user-login: "github-actions[bot]" # The user.login for temporary GitHub tokens
allow-repeats: false # This is the default
8 changes: 4 additions & 4 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ name: Render Website
on:
push:
branches:
- 'main'
- 'master'
- "main"
- "master"

jobs:
build:
Expand All @@ -13,12 +13,12 @@ jobs:
steps:
- uses: actions/checkout@v2
with:
submodules: 'recursive'
submodules: "recursive"

- name: Setup Zig
uses: goto-bus-stop/setup-zig@v2
with:
version: master
version: 0.13.0

- name: Render website
run: |
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
zig-cache/
.zig-cache/
render/
zig-out/
.direnv/
6 changes: 2 additions & 4 deletions build.zig
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,10 @@ const zine = @import("zine");
pub fn build(b: *std.Build) !void {
// zine.scriptyReferenceDocs(b, "content/documentation/scripty/index.md");
try zine.addWebsite(b, .{
.title = "Zig Embedded Group",
.host_url = "https://microzig.tech",
.layouts_dir_path = "layouts",
.content_dir_path = "content",
.static_dir_path = "static",
.site = .{
.base_url = "https://microzig.tech",
.title = "Zig Embedded Group",
},
});
}
4 changes: 2 additions & 2 deletions build.zig.zon
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
.paths = .{"."},
.dependencies = .{
.zine = .{
.url = "https://github.com/kristoff-it/zine/archive/03f80646b83cadb2e693ff5d97445d3e16c8e222.tar.gz",
.hash = "1220e3e4938edf652776349c45b3bb58774d540a050034488ff8dab7dbe410cc2977",
.url = "git+https://github.com/kristoff-it/zine#c4924570fa54ab204bb8b1bf1a140d0cc04ab08a",
.hash = "1220e2050b5fb6788675c0af6b2bfb601226fc90fb32aeeccc95cf9f4945543bd13a",
},
},
}
14 changes: 7 additions & 7 deletions content/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
{
"title": "Home",
"date": "2020-07-06T00:00:00",
"author": "Felix Queißner",
"draft": false,
"layout": "getting-started.html",
"tags": []
}
.title = "Getting Started",
.date = @date("2020-07-06T00:00:00"),
.author = "Felix Queißner",
.draft = false,
.layout = "getting-started.html",
.tags = []
}
---
Dummy, full text is implemented in the HTML file for now.
14 changes: 7 additions & 7 deletions content/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
{
"title": "Home",
"date": "2020-07-06T00:00:00",
"author": "Felix Queißner",
"draft": false,
"layout": "index.html",
"tags": []
}
.title = "Home",
.date = @date("2020-07-06T00:00:00"),
.author = "Felix Queißner",
.draft = false,
.layout = "index.html",
.tags = [],
}
---
Dummy, full text is implemented in the HTML file for now.
14 changes: 7 additions & 7 deletions content/tutorials/01-embedded-basics.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
{
"title": "Embedded Basics",
"date": "2020-07-06T00:00:00",
"author": "Felix Queißner",
"draft": false,
"layout": "tutorial.html",
"tags": []
}
.title = "Embedded Basics",
.date = @date("2020-07-06T00:00:00"),
.author = "Felix Queißner",
.draft = false,
.layout = "tutorial.html",
.tags = []
}
---
# Embedded Basics

Expand Down
18 changes: 9 additions & 9 deletions content/tutorials/02-embedded-programming.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
{
"title": "Embedded Basics",
"date": "2020-07-06T00:00:00",
"author": "Felix Queißner",
"draft": false,
"layout": "tutorial.html",
"tags": []
.title = "Embedded Programming",
.date = @date("2020-07-06T00:00:00"),
.author = "Felix Queißner",
.draft = false,
.layout = "tutorial.html",
.tags = []
}
---
# Embedded Programming
Expand All @@ -14,7 +14,7 @@ In this tutorial, you'll learn the ways of the embedded programmer and how to ma

## Prerequisites

- [Embedded Basics](01-embedded-basics.htm)
- [Embedded Basics](01-embedded-basics/)

## Contents

Expand All @@ -38,7 +38,7 @@ Every embedded programmer requires some materials to get their work done efficie

First of all, the *SOC datasheet*. It contains all relevant information about the SOC/chip you are using, which functions each pin of the package has, where your RAM and flash is located in the memory map and so on. You *will* learn to navigate this document very quickly, as it's the main reference for everything you do.

Second, you need the schematics of the device you want to program. You usually can obtain them from the manufacturer of your development board (assuming you are using one), by the vendor of the device you're hacking (if you are lucky enough) or by reverse engineering the device you have at hands (consider this the *hard mode* of embedded development). Reading a schematic is crucial to get your device do what you want, and you can learn a bit about this in the [Embedded Basics](01-embedded-basics.htm) tutorial.
Second, you need the schematics of the device you want to program. You usually can obtain them from the manufacturer of your development board (assuming you are using one), by the vendor of the device you're hacking (if you are lucky enough) or by reverse engineering the device you have at hands (consider this the *hard mode* of embedded development). Reading a schematic is crucial to get your device do what you want, and you can learn a bit about this in the [Embedded Basics](01-embedded-basics/) tutorial.

These two documents are the ones you *definitly* need and it's near-impossible to work without them. But usually you need more documents than this:
Datasheets for all the peripherial devices like displays, display controllers, motor controllers, expander chips and so on. Another document that helps a lot is the CPU datasheet for the core of your SOC. This document contains a precise description of the startup procedure of your system, what instructions are available, how the interrupts work in detail and similar topics.
Expand All @@ -60,7 +60,7 @@ The RAM will contain garbage after startup. Our variables aren't initialized and

To do this, we first have to tell the compiler to store our pre-initialized data somewhere in flash memory, so we can copy it into RAM at startup. This is done via the linker script:

```ld
```cpp
/* This section declares two memory regions:
* flash: 512k of non-writeable memory at position 0,
* ram: 32k of writeable memory at position 256M
Expand Down
2 changes: 1 addition & 1 deletion layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h2><svg viewBox="0 0 24 24">
</svg>important links</h2>

<ul class="bars">
<li><strong><a href="getting-started.htm">documentation / getting started</a></strong></li>
<li><strong><a href="getting-started/">documentation / getting started</a></strong></li>
<li><a href="https://github.com/ZigEmbeddedGroup/">code</a></li>
<li><a href="https://ziglang.org/">Zig programming language</a></li>
</ul>
Expand Down
Loading