aboutsummaryrefslogtreecommitdiffhomepage
path: root/BUILDING.md
diff options
context:
space:
mode:
authorAyke van Laethem <[email protected]>2020-07-08 01:52:01 +0200
committerRon Evans <[email protected]>2020-07-08 17:35:31 +0200
commit3088dcadece0b27e8c1b274c509585775103f698 (patch)
tree71eb679c2319ec8c582664bdd38f4a6a268ba5c9 /BUILDING.md
parent7ed7e6cb11e3693b65a108b27c139d95c5b533c0 (diff)
downloadtinygo-3088dcadece0b27e8c1b274c509585775103f698.tar.gz
tinygo-3088dcadece0b27e8c1b274c509585775103f698.zip
building: add links to tinygo.org
The BUILDING.md file is not intended for developer builds but for release builds. The website contains more specific and more complete information on how to build TinyGo, so provide links to these pages. The Windows link doesn't work yet, but should work with the next release when we update the website.
Diffstat (limited to 'BUILDING.md')
-rw-r--r--BUILDING.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/BUILDING.md b/BUILDING.md
index f8961fc66..e031a3020 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -10,6 +10,14 @@ This guide describes how to statically link TinyGo against LLVM, libclang and
lld so that the binary can be easily moved between systems. It also shows how to
build a release tarball that includes this binary and all necessary extra files.
+**Note**: this documentation describes how to build a statically linked release
+tarball. If you want to develop TinyGo, you will probably want to follow a
+different guide:
+
+ * [Linux](https://tinygo.org/getting-started/linux/#source-install)
+ * [macOS](https://tinygo.org/getting-started/macos/#source-install)
+ * [Windows](https://tinygo.org/getting-started/windows/#source-install)
+
## Dependencies
LLVM, Clang and LLD are quite light on dependencies, requiring only standard