README.md

Thu, 23 Sep 2021 12:15:33 +0300

author
cemkalyoncu
date
Thu, 23 Sep 2021 12:15:33 +0300
branch
4.x-dev
changeset 1729
06588a526327
parent 1713
80875b924288
permissions
-rw-r--r--

* Timeout and interval functionality

1177
1ec0cf0de825 README.md created online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
diff changeset
1
1ec0cf0de825 README.md created online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
diff changeset
2 GGE 4.x is still in development and is not feature complete.
1ec0cf0de825 README.md created online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
diff changeset
3
1ec0cf0de825 README.md created online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
diff changeset
4 ## Requirements
1655
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
5
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
6 ### Compiler
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
7 * GCC 8+
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
8 * Visual Studio 2019
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
9 * Clang (not fully supported)
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
10
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
11 ### Tools
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
12 * CMake 3.5
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
13 * Doxygen
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
14
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
15 ### Common
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
16 * OpenGL
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
17
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
18 ### Linux
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
19 * libX11, libXinerama, libXrandr, libXext
1177
1ec0cf0de825 README.md created online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents:
diff changeset
20 * libpulse
1655
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
21 * pthreads
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
22 * fontconfig
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
23
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
24 ### Optional (built-in available)
1178
4d7b7e3a305b README.md edited online with Bitbucket
Cem Kalyoncu <cemkalyoncu@gmail.com>
parents: 1177
diff changeset
25 * FreeType2 (For font support, bitmap fonts do not need freetype)
1655
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
26 * libCurl (For HTTP transport, built-in not yet available, disabled by default)
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
27 * FLAC (Lossless audio)
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
28 * Vorbis (Audio)
1513
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
29
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
30 ----
1655
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
31
1514
3f3708af2d91 *Addition of text field paths.
Luca Tonini
parents: 1513
diff changeset
32 ### Fedora 32/33 on 64bit system dependencies
1513
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
33 Run the command below to install all the dependencies on Fedora distros after Fedora 26.
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
34
1707
0b5b95d558f9 * Polyfill now supports strictly outside
cemkalyoncu
parents: 1694
diff changeset
35 ```$ sudo dnf install gcc cmake cmake-gui libX11 libXinerama-devel libXrandr-devel libXext doxygen freetype freetype-devel pulseaudio-libs-devel fontconfig-devel libcurl flac-devel libvorbis-devel```
1655
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
36
1513
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
37 ----
1710
71a4a41b010e - Added ubuntu 18.04 dependencies
dogukangulyasar
parents: 1694
diff changeset
38
71a4a41b010e - Added ubuntu 18.04 dependencies
dogukangulyasar
parents: 1694
diff changeset
39 ### Ubuntu 18.04 64 bit system dependencies
1713
80875b924288 * Edited readme Ubuntu 18.04 dependencies.
dogukangulyasar
parents: 1712
diff changeset
40 Run the command below to install all the dependencies on Ubuntu 18.04.
1710
71a4a41b010e - Added ubuntu 18.04 dependencies
dogukangulyasar
parents: 1694
diff changeset
41
1713
80875b924288 * Edited readme Ubuntu 18.04 dependencies.
dogukangulyasar
parents: 1712
diff changeset
42 ```$ sudo apt-get install gcc cmake cmake-gui libx11-dev libxinerama-dev libxrandr-dev libxtst-dev doxygen freetype libfifechan-dev libfreetype6-dev libpulse-dev libfontconfig1-dev libflac-dev libvorbis-dev```
1710
71a4a41b010e - Added ubuntu 18.04 dependencies
dogukangulyasar
parents: 1694
diff changeset
43
71a4a41b010e - Added ubuntu 18.04 dependencies
dogukangulyasar
parents: 1694
diff changeset
44
71a4a41b010e - Added ubuntu 18.04 dependencies
dogukangulyasar
parents: 1694
diff changeset
45 ----
1513
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
46
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
47 ## Install Gorgon using cmake (Linux)
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
48
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
49 1. Navigate to the Gorgon directory through terminal.
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
50
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
51 2. Inside the Gorgon Directory create a folder called build.
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
52
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
53 ```$ mkdir build```
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
54
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
55 3. Then change directory to build.
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
56
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
57 ```$ cd build```
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
58
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
59 4. Type in the following command to setup the cmake file system.
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
60
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
61 ```$ cmake -S /Path/To/Gorgon -B /Path/To/Gorgon/build```
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
62
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
63 5. Next run the command below to open the cmake gui config file
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
64
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
65 ```$ cmake-gui```
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
66
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
67 a. Set the source code path to /Path/To/Gorgon and the build binaries path to /Path/To/Gorgon/build if not done already, and press Configure if paths were not set. (skip step otherwise)
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
68 b. Set CMAKE_BUILD_TYPE TO Debug
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
69 c. Select desired modules and tools to be installed
1655
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
70 d. If you do not want to install libraries, you may select built-in.
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
71 e. Then click Configure and Generate and close the cmake gui.
1513
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
72
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
73 6. Now run the command below to make files.
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
74
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
75 ```$ make```
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
76
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
77 **Note:** Add -j8, -j4 for the number of CPU cores you would like to use to build Gorgon as it can take time with a sigle core.
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
78
1655
8836c93121df * Visual studio compiler fix
cemkalyoncu
parents: 1514
diff changeset
79 7. Finally install Gorgon using sudo users.
1513
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
80
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
81 ```$ sudo make install```
1197deea44f0 * Update to README file for fedora(Linux) installation
Luca Tonini
parents: 1178
diff changeset
82

mercurial