From a756b443fabd3cac76e271ff895d220cb4506d2d Mon Sep 17 00:00:00 2001 From: Zetok Zalbavar Date: Fri, 22 May 2015 16:42:46 +0100 Subject: [PATCH] [bootstrap.sh] Add some clarification regarding its purpose At times people may be confused with what bootstrap.sh is there for, and thus some clarification regarding it should be available. --- bootstrap.sh | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/bootstrap.sh b/bootstrap.sh index 3f2ee002c..52f312d62 100755 --- a/bootstrap.sh +++ b/bootstrap.sh @@ -1,5 +1,23 @@ #!/usr/bin/env bash +# This script's purpose is to ease compiling qTox for users. +# +# NO AUTOMATED BUILDS SHOULD DEPEND ON IT. +# +# This script is and will be a subject to breaking changes, and at no time one +# should expect it to work - it's something that you could try to use but +# don't expect that it will work for sure. +# +# If script doesn't work, you should use instructions provided in INSTALL.md +# before reporting issues like “qTox doesn't compile”. +# +# With that being said, reporting that this script doesn't work would be nice. +# +# If you are contributing code to qTox that change its dependencies / the way +# it's being build, please keep in mind that changing just bootstrap.sh +# *IS NOT* and will not be sufficient - you should update INSTALL.md first. + + WINDOWS_VERSION=$(cmd.exe /c ver 2>/dev/null | grep "Microsoft Windows") if [ ! -z "$WINDOWS_VERSION" ]; then cd windows