UPDATE readme
This commit is contained in:
parent
a1b526988d
commit
1d44a56603
25
README.md
25
README.md
@ -1,16 +1,27 @@
|
|||||||
|
|
||||||
# Instructions
|
# Instructions
|
||||||
after the project is pulled, run `git submodule update --init --recursive` to pull submodules. This is stuff like abseil and other maps
|
after the project is cloned, run `git submodule update --init --recursive` to pull submodules.
|
||||||
|
This is stuff like abseil and other maps are git submodules that don't get downloaded automatically.
|
||||||
|
|
||||||
make a build directory and run `cmake .. G - "Unix makefiles"` or whatever build system is used
|
To build, just run
|
||||||
then `make` (or whatever build system is used)
|
`mkdir build`
|
||||||
|
`cd build`
|
||||||
|
`cmake .. -G "<Build System>"` and then whatever command the build system uses.
|
||||||
|
For example, with unix maketools:
|
||||||
|
|
||||||
|
`cmake -G "Unix makefiles"`
|
||||||
|
`make`
|
||||||
|
|
||||||
|
But if you still got the same config as the one we all used for parkmanne, you should have vscode + cmaketools plugin. In which case, just press build.
|
||||||
|
|
||||||
This should work, but I've been using vscode with the cmake-tools plugin which does it automatically for me.
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
Install boost. (https://www.boost.org/) should just be `pacman -S boost` on arch based systems.
|
Install boost. (https://www.boost.org/) should just be `pacman -S mingw-w64-x86_64-boost` in the msys2 shell. If you still have the same install as the parkmanne project, you already have this installed. DW about it.
|
||||||
There was no easy way to include it in the source, so we installed it with the OS package manager.
|
If you don't for some reason, see command above. If you don't have the same setup anymore, ask me. Stefan, it is `apt install libboost-all-dev` if i remember correctly.
|
||||||
|
We need it for `boost::unordered`, and i have no easy way to include it in the project.
|
||||||
|
|
||||||
Also, this is only tested on linux. It *should* work on windows. I remember it working on windows, but I recently did a fresh install on windows after getting an SSD and I'm having trouble configuring clang to work for projects I was able to compile in the past.
|
Also, this is only tested on linux. It *should* work on windows. I remember it working on windows, but I recently did a fresh install on windows after getting an SSD and I'm having trouble configuring clang to work for projects I was able to compile in the past.
|
||||||
Assume it doesnt and compile on linux.
|
Assume it doesnt and compile on linux.
|
||||||
|
|
||||||
Also, make sure your compiler supports C++17. That should be the latest versions all major compilers (clang 5+, gcc 7+, msvc 19.14+ (Visual studio 2017+))
|
Also, make sure your compiler supports C++17. That should be the latest versions all major compilers (clang 5+, gcc 7+, msvc 19.14+ (Visual studio 2017+))
|
||||||
We're at VS2019, clang 10 and gcc 9 now, so this shouldn't be an issue unless your compilers are horribly outdated. If you updated anywhere in the past 3-4 years, you should be fine.
|
We're at VS2019, clang 10 and gcc 9 now, so this shouldn't be an issue if you still got the parkmanne setup.
|
||||||
|
Loading…
Reference in New Issue
Block a user