Commit 2077fb5b authored by Bastian Krayer's avatar Bastian Krayer

Update README.md

parent dd4e6b1a
## IDEs
## Recommended IDEs
We recommend CLion, which you can get for free with your student e-mail address. This is of course no requirement, as you may use any other IDE. One completely free and well working one is QtCreator (Offline downloader at https://www.qt.io/offline-installers). Using Visual Studio should also work well. All of these allow for just opening the CMakeLists.txt as a project.
### QtCreator
Free and fast IDE for all platforms. Offline installer can be found here: https://www.qt.io/offline-installers
You can just skip account creation during installation. Make sure to add the QtCreator bin directory to your path environment variable. If you have trouble opening the project with QtCreator and MinGW-w64 on windows, check out the following hints: https://owncloud.uni-koblenz-landau.de/owncloud/s/LEjP7HQMR4zDb4a
### CLion
A full featured non-free cross platform IDE: https://www.jetbrains.com/clion
You can get a free student license by registering with your ...@uni-koblenz.de address.
### Visual Studio
A full featured IDE for Windows. The community edition is free, but requires a Microsoft account. https://visualstudio.microsoft.com/de/vs/community/
### Eclipse
Free cross platform IDE. Recent versions seem to have trouble with C++: https://www.eclipse.org/downloads/
## Quick setup Mac OS X
IN NEED OF TESTING
#### Clion setup (recommended)
- install dependencies via homebrew or macports (e.g. ```brew install homebrew/versions/glfw3 glm```)
- download and install [Clion IDE](https://www.jetbrains.com/clion/) (register with your ...@uni-koblenz.de address to get a free student license)
- click "Check out from Version Control" and clone the repository (```git@gitlab.uni-koblenz.de:cg/ws19ansim.git``` or ```https://gitlab.uni-koblenz.de/cg/ws19ansim.git```)
### Quick setup
#### Console setup
- install dependencies via homebrew or macports (e.g. ```brew install homebrew/versions/glfw3 glm```)
- install dependencies via homebrew or macports (e.g. ```brew install homebrew/versions/glfw3 glm assimp```)
- clone repository to some place (with ```git clone git@gitlab.uni-koblenz.de:cg/ws19ansim.git``` or ```git clonehttps://gitlab.uni-koblenz.de/cg/ws19ansim.git```)
- prompt in AnSim folder and create a build folder: ```mkdir & cd build```
- run cmake ```cmake ..```
- type ```make```. To utilize more CPU-Cores you might add -jX to the make call. eg: ```make -j4```
- Open the project
- In some IDEs, like CLion, QtCreator or Visual Studio, you can directly open the CMakeLists.txt file inside the src directory
- Otherwise run setup_mac.sh to setup your project!
Happy Coding!
---
## Quick setup Windows
### Quick setup Windows
- clone repository to some place
- download the dependencies (https://owncloud.uni-koblenz-landau.de/owncloud/s/AycR2askPsMMsyJ)
- **Important**: Supported Compilers are Visual Studio 17 and MinGW-w64 (http://mingw-w64.org)
- Recommended MinGW-w64 installation with MSys2 (https://www.msys2.org/)
- Download the 64-bit version
- Initial setup instructions with pacman on that site
- Afterwards install MinGW toolchain with `pacman -S mingw-w64-x86\_64-toolchain`
- Add PATH_TO_MSYS/mingw64/bin to path environment variable
- Afterwards install MinGW toolchain with `pacman -S mingw-w64-x86_64-toolchain`
- Add PATH_TO_MSYS/mingw64/bin to path environment variable, by default this is C:\msys64\mingw64\bin
- SetEnvironment.bat sets environment variables: OpenGL_ROOT GLM_ROOT GLFW3_ROOT ASSIMP_ROOT
- run setup_win.bat to setup your project!
- Open the project
- In some IDEs, like CLion, QtCreator or Visual Studio, you can directly open the CMakeLists.txt file inside the src directory
- Otherwise run setup_win.bat to setup your project!
Happy Coding!
---
## Quick setup Linux (dependencies for ubuntu)
### Quick setup Linux (dependencies for ubuntu)
Tested on Ubuntu 16.04 Should work very similar on different distributions
#### Clion setup
- use your package-manager to install the dependencies (GLM, GLFW, GLEW, assimp, Xrandr, Xi)
Ubuntu: ```sudo apt-get install libglm-dev libglfw3-dev libglew-dev libassimp-dev libxrandr-dev libxi-dev```
- use your package-manager to install the dependencies (GLM, GLFW, assimp, Xrandr, Xi)
Ubuntu: ```sudo apt-get install libglm-dev libglfw3-dev libassimp-dev libxrandr-dev libxi-dev```
- download and install [Clion IDE](https://www.jetbrains.com/clion/) (register with your ...@uni-koblenz.de address to get a free student license)
- click "Check out from Version Control" and clone the repository
#### Console setup
- clone repository to some place
- use your package-manager to install the dependencies (GLM, GLFW, GLEW, assimp, Xrandr, Xi)
Ubuntu: ```sudo apt-get install libglm-dev libglfw3-dev libglew-dev libassimp-dev libxrandr-dev libxi-dev```
- use your package-manager to install the dependencies (GLM, GLFW, assimp, Xrandr, Xi)
Ubuntu: ```sudo apt-get install libglm-dev libglfw3-dev libassimp-dev libxrandr-dev libxi-dev```
- prompt in CG3 folder and execute the setup_linux.sh shellscript: "sh setup_linux.sh"
- chose your prefered IDE or generate make files.
- Open the project
- In some IDEs, like CLion, QtCreator or Visual Studio, you can directly open the CMakeLists.txt file inside the src directory
- Otherwise run setup_linux.sh to setup your project!
Happy Coding!
---
### Troubleshooting
If on Git clone you are prompted for a password like git@gitlab.com's password: something is wrong with your SSH setup. You can try to clone the repository with the https link (https://gitlab.uni-koblenz.de/cg/ws19ansim.git)
or you should ...
- ensure that you generated your SSH key pair correctly and added the public SSH key to your GitLab profile
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment