Add note about Go toolchain needing to be installed

hwittenborn · Jun 4, 2023 · c5557bd · c5557bd
1 parent 2b1c263
commit c5557bd
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "husk"
-version = "0.1.2"
+version = "0.1.3"
 authors = ["Hunter Wittenborn <hunter@hunterwittenborn.com>"]
 edition = "2021"
 description = "Rust bindings for the mvdan.cc/sh Golang library"

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,4 +1,8 @@
 //! This crate provides bindings to the [`mvdan.cc/sh` Golang library](https://pkg.go.dev/mvdan.cc/sh).
+//!
+//! # Note
+//! As this library is a wrapper around a Golang library, you'll need the [Go
+//! toolchain](https://go.dev/) installed on your system in order to build it.
 pub mod shell;
 pub mod syntax;
 pub mod util;