Extend build manual

[keszocze]

The README.md should mention that the 'dependencies' folder needs to be manually pulled from github. If not, the error message is rather cryptic, not really giving a hint what has to be done.

ATM, the readme states 'The bootstrap.sh script provided by metaSMT can automatically download and install dependencies needed by metaSMT [...]' which is misleading as one has to download the dependencies manually (the git repo containing the dl information, that is).

[finnhaedicke]

@keszocze: How do you like this version of the paragraph?

The bootstrap.sh script provided by metaSMT can automatically download the dependencies needed by metaSMT and setup a metaSMT build folder.
For the Git version of metaSMT you need to manually checkout the repository from https://github.com/agra-uni-bremen/dependencies.
You may require subversion and git to be installed.

[hriener]

@finnhaedicke: That sounds very good! Maybe it's also useful to add a statement to the error message produced by the ''bootstrap.sh'' script that refers to the README file.

[finnhaedicke]

@hriener The error message currently is

if ! cd dependencies; then
  echo "missing dependencies folder. Please manually create a checkout or symlink in the metaSMT base folder."
  exit 2
fi

We could add
echo Please refer to the README.md for more details.

[hriener]

👍

echo ''missing "dependencies" directory. Please refer to the README.md for more details.''

[keszocze]

I would suggest the following:

1. To "0. Preparation" add the text (just a suggestion!):
   "metaSMT heavily relies on different dependencies (e.g. the different solving engines). For a succesfull build, a folder named 'dependencies' containing them is expetected to be present in the metaSMT main folder.
   You can either freshly clone the repository from https://github.com/agra-uni-bremen/dependencies.git
   or symlink to an existing dependencies folder. The foldername 'dependencies' is fixed and can not
   be changed"

Wich brings up the questions:

• Why can't I change this folder name?
• What happens if I use the option --deps dependencies/

2. Add an option, --dl-dependencies or --clone-dependencies to the bootsrap.sh that performs
   the git clone command.

3. Use the error messages proposed by hriener:
   echo ''missing "dependencies" directory. Please refer to the README.md for more details.''

[hriener]

I think @keszocze has some good points and his suggestion is very well thought.

Two more points:

• It would be valuable if metaSMT could be build in a ''sane'' setting just by calling bootstraph.sh. Once people are addicted to the pure design and feature set offered, we can still point them to the README for learning about specialist configurations.
• A lot of metaSMT bootstrap sessions fail in the first. It would be nice to have some advice in the README how to go on after an issue has been fixed (without building metaSMT again from scratch).