From ac9b1c260e4401ceccf0a682ffe1609e342c990c Mon Sep 17 00:00:00 2001 From: Tetralux <1348560+Tetralux@users.noreply.github.com> Date: Fri, 28 Jun 2019 16:30:53 +0100 Subject: [PATCH 1/3] Mention stdlib docs, or lack thereof I can remove the change to the `Resources` section if preferred. --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3312fa365080..c73ce93449b1 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,20 @@ Zig is an open-source programming language designed for **robustness**, ## Resources * [Introduction](https://ziglang.org/#Introduction) - * [Download & Documentation](https://ziglang.org/download) + * [Download & Documentation](https://ziglang.org/download) (These docs function as the quick-reference guide.) * [Community](https://github.com/ziglang/zig/wiki/Community) * [Contributing](https://github.com/ziglang/zig/blob/master/CONTRIBUTING.md) +## Standard Library Docs + +Documentation for the standard library doesn't exist yet, though there will be full docs by version 1.0. +For now, you can search through `std/` for items of interest with a text editor. + +It isn't a priority right now as the focus on more on implementing features and getting stuff working well. + +If you have any questions on how parts of the stdlib work, you can always ask us about it; see the 'Community' resource above. + + ## Building from Source [![Build Status](https://dev.azure.com/ziglang/zig/_apis/build/status/ziglang.zig?branchName=master)](https://dev.azure.com/ziglang/zig/_build/latest?definitionId=1&branchName=master) From c72169e7420bc4279e80c9409d9c54ddcdd27ee2 Mon Sep 17 00:00:00 2001 From: Tetralux <1348560+Tetralux@users.noreply.github.com> Date: Sat, 29 Jun 2019 18:41:22 +0100 Subject: [PATCH 2/3] fix typo Co-Authored-By: Komu Wairagu --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c73ce93449b1..dc0a3cb70625 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Zig is an open-source programming language designed for **robustness**, Documentation for the standard library doesn't exist yet, though there will be full docs by version 1.0. For now, you can search through `std/` for items of interest with a text editor. -It isn't a priority right now as the focus on more on implementing features and getting stuff working well. +It isn't a priority right now as the focus is more on implementing features and getting stuff working well. If you have any questions on how parts of the stdlib work, you can always ask us about it; see the 'Community' resource above. From 4359102e2de49dadfae38973ff8fd9aec950eefc Mon Sep 17 00:00:00 2001 From: Tetralux <1348560+Tetralux@users.noreply.github.com> Date: Sat, 29 Jun 2019 18:44:08 +0100 Subject: [PATCH 3/3] mention FAQ --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index dc0a3cb70625..90858e4b808c 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ Zig is an open-source programming language designed for **robustness**, * [Introduction](https://ziglang.org/#Introduction) * [Download & Documentation](https://ziglang.org/download) (These docs function as the quick-reference guide.) + * [Frequently Asked Questions](https://github.com/ziglang/zig/wiki/FAQ) * [Community](https://github.com/ziglang/zig/wiki/Community) * [Contributing](https://github.com/ziglang/zig/blob/master/CONTRIBUTING.md)