diff --git a/README.md b/README.md index 1a44ae3..0aaf896 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# microzig +![microzig logo](design/logo-text-auto.svg) [![discord](https://img.shields.io/discord/824493524413710336.svg?logo=discord)](https://discord.gg/ShUWykk38X) @@ -6,15 +6,14 @@ APIs will likely break in the future -Table of Contents -================= +# Table of Contents - * [Contributing](#contributing) - * [Introduction](#introduction) - * [How to](#how-to) - * [Embedded project with "supported" chip/board](#embedded-project-with-supported-chipboard) - * [Embedded project with "unsupported" chip](#embedded-project-with-unsupported-chip) - * [Interrupts](#interrupts) +- [Contributing](#contributing) +- [Introduction](#introduction) +- [How to](#how-to) + - [Embedded project with "supported" chip/board](#embedded-project-with-supported-chipboard) + - [Embedded project with "unsupported" chip](#embedded-project-with-unsupported-chip) + - [Interrupts](#interrupts) @@ -26,6 +25,7 @@ There will be issues marked as `good first issue`, or drafts for larger ideas th ## Introduction This repo contains the infrastructure for getting started in an embedded Zig project, as well as some code to interact with some chips/boards. Specifically it offers: + - a single easy-to-use builder function that: - generates your linker script - sets up packages and start code @@ -87,6 +87,7 @@ pub fn main() !void { If you have a board/chip that isn't defined in microzig, you can set it up yourself! You need to have: + - SVD or ATDF file defining registers - flash and ram address and sizes diff --git a/design/logo-text-auto.svg b/design/logo-text-auto.svg new file mode 100644 index 0000000..ab40494 --- /dev/null +++ b/design/logo-text-auto.svg @@ -0,0 +1,13 @@ + + + + + + + + \ No newline at end of file diff --git a/design/logo-text-brightmode.svg b/design/logo-text-brightmode.svg new file mode 100644 index 0000000..c048b67 --- /dev/null +++ b/design/logo-text-brightmode.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/design/logo-text-darkmode.svg b/design/logo-text-darkmode.svg new file mode 100644 index 0000000..f744c99 --- /dev/null +++ b/design/logo-text-darkmode.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/design/logo-text-inkscape-variant-1.svg b/design/logo-text-inkscape-variant-1.svg deleted file mode 100644 index f26743e..0000000 --- a/design/logo-text-inkscape-variant-1.svg +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - MicroZig - - diff --git a/design/logo-text-inkscape-variant-2.svg b/design/logo-text-inkscape-variant-2.svg deleted file mode 100644 index 875cef6..0000000 --- a/design/logo-text-inkscape-variant-2.svg +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - MicroZig - - diff --git a/design/logo-text-inkscape.svg b/design/logo-text-inkscape.svg index 69dba8b..210065c 100644 --- a/design/logo-text-inkscape.svg +++ b/design/logo-text-inkscape.svg @@ -2,16 +2,15 @@ + inkscape:current-layer="layer1" + showguides="true" + inkscape:guide-bbox="true"> + + + - - + + + MicroZig + style="font-size:112.46px;line-height:1.25;font-family:'Dash Horizon';-inkscape-font-specification:'Dash Horizon, Normal';fill:#acacac;stroke-width:2.86448;fill-opacity:1"> + + + + + + + + + + diff --git a/design/logo-text-variant-1.svg b/design/logo-text-variant-1.svg deleted file mode 100644 index 530592f..0000000 --- a/design/logo-text-variant-1.svg +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/design/logo-text-variant-2.svg b/design/logo-text-variant-2.svg deleted file mode 100644 index 9a732cb..0000000 --- a/design/logo-text-variant-2.svg +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/design/logo.svg b/design/logo.svg index 3e5f419..c48f717 100644 --- a/design/logo.svg +++ b/design/logo.svg @@ -1,9 +1 @@ - - - - - - - - - +