diff --git a/build.sh b/build.sh index aed3f28..f5df280 100755 --- a/build.sh +++ b/build.sh @@ -1,4 +1,10 @@ #!/usr/bin/env bash +# +# Build and install the cctools the SDK and macports. +# +# This script requires the OS X SDK and the Clang/LLVM compiler. +# + pushd "${0%/*}" &>/dev/null diff --git a/build_binutils.sh b/build_binutils.sh index e3c1756..1a259fa 100755 --- a/build_binutils.sh +++ b/build_binutils.sh @@ -1,4 +1,11 @@ #!/usr/bin/env bash +# +# Build and install the GNU binutils and the GNU Debugger (gdb) for +# target OS X. +# +# You may want to run this script if you want to build software using +# gcc. Please refer to the README.md for details. +# pushd "${0%/*}" &>/dev/null diff --git a/build_clang.sh b/build_clang.sh index 6713b59..585fc96 100755 --- a/build_clang.sh +++ b/build_clang.sh @@ -1,4 +1,11 @@ #!/usr/bin/env bash +# +# Build and install Clang/LLVM, using `gcc`. +# +# You only need to run this if your distribution does not provide +# clang - or if you want to build your own version from a recent +# source tree. +# pushd "${0%/*}" &>/dev/null diff --git a/build_compiler_rt.sh b/build_compiler_rt.sh index d3d3fde..5f70668 100755 --- a/build_compiler_rt.sh +++ b/build_compiler_rt.sh @@ -1,4 +1,10 @@ #!/usr/bin/env bash +# +# Build and install the "compiler-rt" runtime library. +# +# This requires that you already finished `build.sh`. +# Please refer to README.COMPILER-RT.md for details. +# pushd "${0%/*}" &>/dev/null diff --git a/build_gcc.sh b/build_gcc.sh index afa5202..3af5352 100755 --- a/build_gcc.sh +++ b/build_gcc.sh @@ -1,4 +1,11 @@ #!/usr/bin/env bash +# +# Build and install gcc/gcc++ as a cross-compiler with target OSX, +# using `clang`. +# +# You may want to run this script if you want to build software using +# gcc. Please refer to the README.md for details. +# pushd "${0%/*}" &>/dev/null diff --git a/build_llvm_dsymutil.sh b/build_llvm_dsymutil.sh index 3fd6738..af677f7 100755 --- a/build_llvm_dsymutil.sh +++ b/build_llvm_dsymutil.sh @@ -1,4 +1,9 @@ #!/usr/bin/env bash +# +# Build and install the `llvm-dsymutil` tool required for debugging. +# +# Please refer to README.DEBUGGING.md for details. +# pushd "${0%/*}" &>/dev/null