-
Notifications
You must be signed in to change notification settings - Fork 133
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #30 from mani-monaj/docs-update
Update documentation and CI
- Loading branch information
Showing
6 changed files
with
157 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| language: cpp | ||
|
|
||
| compiler: | ||
| - gcc | ||
|
|
||
| # by default Ubuntu Precise is included | ||
| # this results on 3 build configurations: | ||
| # Ubuntu Precise and Trusty + Latest OSX image | ||
| matrix: | ||
| include: | ||
| - os: linux | ||
| dist: trusty | ||
| sudo: required | ||
| - os: osx | ||
| osx_image: xcode8 | ||
|
|
||
| addons: | ||
| apt: | ||
| packages: | ||
| - cmake | ||
| - libqt4-dev | ||
| - libgl1-mesa-dev | ||
| - libglu1-mesa-dev | ||
| - libprotobuf-dev | ||
| - protobuf-compiler | ||
| - libode-dev | ||
| - libboost-dev | ||
|
|
||
| before_install: | ||
| - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update ; fi | ||
| - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install qt4 ; fi | ||
| - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install protobuf ; fi | ||
| - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install ode --with-double-precision ; fi | ||
|
|
||
| install: | ||
| # vartypes | ||
| - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then git clone https://github.com/szi/vartypes.git ; fi | ||
| - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then git clone https://github.com/lordhippo/vartypes.git -b osx-fix; fi | ||
| - cd vartypes | ||
| - mkdir build && cd build | ||
| - cmake .. | ||
| - make | ||
| - sudo make install | ||
|
|
||
| script: | ||
| # grsim | ||
| - cd $TRAVIS_BUILD_DIR | ||
| - mkdir build && cd build | ||
| - cmake .. | ||
| - make | ||
| - sudo make install |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,19 @@ | ||
| # Head Developer | ||
| - Ali Koochakzadeh - Amirkabir University of Technology (ali.koochakzade@gmail.com) | ||
| ## Authors | ||
|
|
||
| grSim was originally developed by [Ali Koochakzadeh](https://github.com/ali-k) and [Mani Monajjemu](https://mani.im) from [Parsian](http://wiki.robocup.org/Small_Size_League/Teams#Parsian), the RoboCup Small Size Team of [Amirkabir University of Technology](http://www.aut.ac.ir/aut/). Since 2011, it has received numerous contributions from the RoboCup SSL community as well as Parsian team members (listed below). grSim is Currently maintained by [Mohammad Mahdi Rahimi](https://github.com/Mahi97). | ||
|
|
||
| # Project Manager | ||
| - Mani Monajjemi - Simon Fraser University (https://github.com/mani-monaj) | ||
| ### Contributers | ||
|
|
||
| - [Christopher Head](https://github.com/Hawk777) - Thunderbots (University of British Coloumbia) | ||
| - [Jonathan Fraser](https://github.com/Binaryblade) - Thunderbots (University of British Coloumbia) | ||
| - [Verónica Raspeño](vero.uc3m@gmail.com) - University Carlos III of Madrid | ||
| - [Alejandro Caparrós](alexcap.uc3m@gmail.com) - University Carlos III of Madrid | ||
| - [Jan Segre](jan@segre.in) - RoboIME | ||
| - [Henrique Bonini de Britto Menezes](henrique.menezes@usp.br) - Universidade de São Paulo | ||
|
|
||
| # Other Contributers | ||
| - Christopher Head - University of British Coloumbia (https://github.com/Hawk777) | ||
| - Jonathan Fraser - University of British Coloumbia (https://github.com/Binaryblade) | ||
| - Verónica Raspeño - University Carlos III of Madrid- (vero.uc3m@gmail.com) | ||
| - Alejandro Caparrós - University Carlos III of Madrid - (alexcap.uc3m@gmail.com) | ||
| - Jan Segre - RoboIME Team (jan@segre.in) | ||
| - Henrique Bonini de Britto Menezes - Universidade de São Paulo - (henrique.menezes@usp.br) | ||
| ### Contributers from Parsian SSL | ||
|
|
||
| # Contributers from Parsian Small Size Team from Amirkabir University of Technology | ||
| - Sepehr Mohaimanianpour (s.mehdi.mohaimanianpour@gmail.com) | ||
| - Arash Behmand (arashbehmand@gmail.com) | ||
| - Mohammad Mahdi Rahimi (https://github.com/Mahi97) | ||
| - Ehsan Omidi (ehomid@microsoft.com) | ||
| - [Sepehr Mohaimanianpour](http://sepehr.im) | ||
| - [Arash Behmand](https://github.com/arashbehmand) | ||
| - [Mohammad Mahdi Rahimi](https://github.com/Mahi97) | ||
| - [Ehsan Omidi](#) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,113 +1,117 @@ | ||
| # GrSim - INSTALL | ||
|
|
||
| ## Overview | ||
|
|
||
| We developed grSim on Ubuntu 9.10+ OS. (Ubuntu 14.04+ tested and is recommended). It is very important that the Graphics Card Driver is installed. (Ubuntu packages of nVidia and AMD(ATI) graphics cards are available). grSim will compile and run in both 32 and 64 bits Linux and Mac-osx. | ||
| We developed grSim on Ubuntu OS. (Ubuntu 14.04+ tested and is recommended). It is important that the graphics card driver is installed properly (the official Ubuntu packages for nVidia and AMD(ATI) graphics cards are available). grSim will compile and run in both 32 and 64 bits Linux and Mac OS. | ||
|
|
||
| GrSim is written in C++, in order to compile it, you will need a working toolchain and a c++ compiler. | ||
|
|
||
| ## Dependencies | ||
|
|
||
| GrSim depends on: | ||
|
|
||
| - OpenGL <https://www.opengl.org> | ||
| - Qt4 Development Libraries <https://www.qt.io> | ||
| - Open Dynamics Engine (ODE) <http://www.ode.org> | ||
| - VarTypes Library <https://github.com/szi/vartypes> | ||
| - Google Protobuf <https://github.com/google/protobuf> | ||
|
|
||
| We use CMake <http://www.cmake.org/> to build and install GrSim. | ||
| - [CMake](https://cmake.org/) version 2.8+ | ||
| - [OpenGL](https://www.opengl.org) | ||
| - [Qt4 Development Libraries](https://www.qt.io) version 4.8+ | ||
| - [Open Dynamics Engine (ODE)](http://www.ode.org) | ||
| - [VarTypes Library](https://github.com/szi/vartypes) | ||
| - [Google Protobuf](https://github.com/google/protobuf) | ||
| - [Boost development libraries](http://www.boost.org/) (needed by VarTypes) | ||
|
|
||
| **Note:** It's necessary to compile ODE in double precision. This is default when installing the ODE binaries in Ubuntu. However, if you are compiling ODE from source (e.g on Mac OS), please make sure to enable the double precision during the configuration step: `./configure --enable-double-precision`. | ||
|
|
||
| > It's neccessery to use ode double percision so if you'r using source code, please attention to use `./configure --enable-double-precision` for configuration. | ||
| ## Linux/Unix Installation | ||
| ### Linux/Unix Installation | ||
|
|
||
| If you run a Debian system, or derivative, first ensure that these dependencies are there: | ||
|
|
||
| ```bash | ||
| sudo apt-get install build-essential cmake libqt4-dev libgl1-mesa-dev libglu1-mesa-dev libprotobuf-dev protobuf-compiler libode-dev | ||
| $ sudo apt-get install git build-essential cmake libqt4-dev libgl1-mesa-dev libglu1-mesa-dev libprotobuf-dev protobuf-compiler libode-dev libboost-dev | ||
| ``` | ||
|
|
||
| Next we need to install VarTypes manually, which itself depends on Qt4 so please make sure that you installed Qt4 first : | ||
| Next compile and install VarTypes from source. In the following we install VarTypes from source using `git`. | ||
|
|
||
| $ (Get VarTypes) | ||
| $ cd ./vartypes | ||
| $ mkdir build | ||
| $ cd build | ||
| $ cmake .. | ||
| $ make | ||
| $ sudo make install | ||
| ```bash | ||
| $ cd /tmp | ||
| $ git clone https://github.com/szi/vartypes.git | ||
| $ cd vartypes | ||
| $ mkdir build | ||
| $ cd build | ||
| $ cmake .. | ||
| $ make | ||
| $ sudo make install | ||
| ``` | ||
|
|
||
| Next, pull down the project: | ||
| Next, clone grSim into your preferred location. | ||
|
|
||
| $ git clone https://github.com/mani-monaj/grSim.git | ||
| $ cd ./grSim | ||
| ```bash | ||
| $ cd /path/to/grsim_ws | ||
| $ git clone https://github.com/mani-monaj/grSim.git | ||
| $ cd grSim | ||
| ``` | ||
|
|
||
| Create a build directory within the project (this is ignored by .gitignore): | ||
|
|
||
| $ mkdir build | ||
| $ cd build | ||
| ```bash | ||
| $ mkdir build | ||
| $ cd build | ||
| ``` | ||
|
|
||
| Run CMake to generate the makefiles: | ||
|
|
||
| $ cmake .. | ||
| ```bash | ||
| $ cmake .. | ||
| ``` | ||
|
|
||
| Then compile the program: | ||
|
|
||
| $ make | ||
|
|
||
| The program is now under ../bin directory with the name grSim. You can run it from here just by typing "../bin/grSim" | ||
|
|
||
| ## Mac OS X Installation | ||
|
|
||
| To make it easier to install the dependencies, you can use a package manager like Homebrew. | ||
| First ensure the dependencies are there: | ||
|
|
||
| $ brew install cmake | ||
| $ brew install ode --enable-double-precision | ||
| $ brew install qt4 | ||
| $ brew install protobuf | ||
|
|
||
| If you run into build issues, you may need to run this first: | ||
|
|
||
| $ brew update | ||
| $ brew doctor | ||
| ```bash | ||
| $ make | ||
| ``` | ||
|
|
||
| Next we need to install VarTypes manually : | ||
| The binary is copied to the `../bin` folder after a successful compilation. | ||
|
|
||
| > Note : the vartypes need some edits to be compatible with mac-osx so it's recommanded to use : | ||
| > <https://github.com/lordhippo/vartypes.git> (branch -> osx-fix) | ||
| ### Mac OS X Installation | ||
|
|
||
| Pre-requirements: | ||
|
|
||
| $ (Get VarTypes) | ||
| $ cd ./vartypes | ||
| $ mkdir build | ||
| $ cd build | ||
| $ cmake .. | ||
| $ make | ||
| $ sudo make install | ||
| - [Xcode](https://developer.apple.com/xcode/) or Xcode Command Line Tools 8.0 or newer | ||
| - [Homebrew](http://brew.sh/) package manager. | ||
|
|
||
| Next, pull down the project: | ||
| First ensure the dependencies are there: | ||
|
|
||
| $ git clone https://github.com/mani-monaj/grSim.git | ||
| $ cd ./grSim | ||
| ```bash | ||
| $ brew install cmake | ||
| $ brew install ode --with-double-precision | ||
| $ brew install qt4 | ||
| $ brew install protobuf | ||
| ``` | ||
|
|
||
| Create a build directory within the project (this is ignored by .gitignore): | ||
| If you run into build issues, you may need to run this first: | ||
|
|
||
| $ mkdir build | ||
| $ cd build | ||
| ```bash | ||
| $ brew update | ||
| $ brew doctor | ||
| ``` | ||
|
|
||
| Run CMake to generate the makefiles: | ||
| Next we need to install VarTypes manually. Please refer to the documentation above for the procedure. | ||
|
|
||
| $ cmake .. | ||
| **IMPORTANT NOTE:** VarTypes currently does not compile on MacOS. Please use the following fork of Vartypes instead of the official repository: `https://github.com/lordhippo/vartypes.git (branch: osx-fix)` | ||
|
|
||
| Then compile the program: | ||
| The steps to compile grSim on Mac OS is similar to the steps outlines above for Linux: | ||
|
|
||
| $ make | ||
|
|
||
| The program is now under `../bin` directory with the name grSim. You can run it from here just by typing `../bin/grSim`; | ||
| ```bash | ||
| $ cd /path/to/grsim_ws | ||
| $ git clone https://github.com/mani-monaj/grSim.git | ||
| $ cd ./grSim | ||
| $ mkdir build | ||
| $ cd build | ||
| $ cmake .. | ||
| $ make | ||
| ``` | ||
|
|
||
| The binary files (grSim and the sample client) will be placed in `../bin`. | ||
|
|
||
| you may want to use a cmake-gui instead of cmake, or maybe ccmake for ncurses fans. | ||
| ## Notes on the performance | ||
|
|
||
| The binary files (grSim and sample client) will be placed in `./bin`. Check the fps in status bar, if it is running on 65fps everything is ok, otherwise check the graphics card installation and OpenGL settings. If you received linker error about GL related libraries, also check your graphics card driver | ||
| When running grSim, check the FPS in the status bar. If it is running at **60 FPS** or higher, everything is ok. Otherwise check the graphics card's driver installation and OpenGL settings. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.