Fix the build instructions #1616
Conversation
docs/README-dev.md
Outdated
| cd <colobot_repository> | ||
| git clone https://github.com/colobot/colobot.git | ||
| cd colobot | ||
| git switch master # or dev (see above) |
There was a problem hiding this comment.
I'd change comment to something like # if you intend to work with last release code.
The switch to dev branch being default branch was meant to make it easier to work on more up-to-date code and create pull request to this branch. Making everyone switch to master anyway defeats this purpose.
There was a problem hiding this comment.
You mean switch this around? Like this?
git switch dev # or master (see above)
Edit: I see no point in repeating what is said earlier in README-dev.md so I'm simply referencing it with "see above"
There was a problem hiding this comment.
Switching it around doesn't make sense, because when you clone repository without any other flags you're already on dev. The point is to make it clear this line is optional.
Your comment might suggest that this is mandatory to switch to master branch before making any work, while in most cases it shouldn't be required. Unless you're package maintainer, or you want to fix some serious bug ASAP.
There was a problem hiding this comment.
I see. Then I'll just delete the line. The option of switching to master is already implied in "Branch setup".
docs/README-dev.md
Outdated
| cd colobot | ||
| git switch master # or dev (see above) | ||
| git submodule update --init | ||
| ln --symbolic ../src/graphics/opengl/shaders/ data/ # ON BRANCH dev RUN THIS INSTEAD: ln --symbolic ../colobot-base/graphics/opengl33/shaders/ data/ |
There was a problem hiding this comment.
I'm curious about this line. When is it needed?
There was a problem hiding this comment.
This line is needed if you want to be able to use any renderer other than gl14. On dev there is no gl14 so this line is always needed. Without this we get a blank black screen:
| mkdir build | ||
| cmake ../ | ||
| cd build | ||
| cmake -D TRANSLATIONS=OFF ../ # You can't compile translations unless you have python2 |
There was a problem hiding this comment.
TRANSLATIONS=OFF should be removed once colobot/colobot-data#88 is merged AND both dev and master use the new data.
Update: colobot/colobot-data#88 has been merged, but git submodule has not been updated.
I have managed to compile the game, despite incorrect build instructions and other difficulties.
Edit: building the game and getting it to run required a lot of trial-and-error (especially the dev branch). I added more complete build instructions to reduce the trial-and-error for future contributors.
Design philosophy:
Note: the instructions are missing a step: the installation of dependencies. I do not intend to add this step in this pull request.