Small documentation update.

This commit is contained in:
Leon Styhre 2021-05-04 17:22:06 +02:00
parent 08cca62b95
commit 9c4b116681
2 changed files with 64 additions and 7 deletions

View file

@ -115,6 +115,15 @@ cmake .
make make
``` ```
By default the master branch will be used, which is where the development takes place. To instead build the latest stable release, switch to the `stable` branch:
```
cd emulationstation-de
git checkout stable
cmake .
make
```
To create a debug build, run this instead: To create a debug build, run this instead:
``` ```
cmake -DCMAKE_BUILD_TYPE=Debug . cmake -DCMAKE_BUILD_TYPE=Debug .
@ -313,17 +322,24 @@ The package can now be installed using a package manager, for example apt:
sudo apt install ./emulationstation-de-1.0.0-x64.deb sudo apt install ./emulationstation-de-1.0.0-x64.deb
``` ```
For RPM packages, remove the comment in es-app/CMakeLists.txt accordingly, from: To build an RPM package instead, set the flag LINUX_CPACK_GENERATOR to RPM when running cmake, for example:
``` ```
#SET(CPACK_GENERATOR "RPM") cmake -DLINUX_CPACK_GENERATOR=RPM .
```
to:
```
SET(CPACK_GENERATOR "RPM")
``` ```
Then simply run cpack. Then simply run `cpack`:
```
myusername@computer:~/emulationstation-de$ cpack
CPack: Create package using RPM
CPack: Install projects
CPack: - Run preinstall target for: emulationstation-de
CPack: - Install project: emulationstation-de []
CPack: Create package
CPackRPM: Will use GENERATED spec file: /home/myusername/emulationstation-de/_CPack_Packages/Linux/RPM/SPECS/emulationstation-de.spec
CPack: - package: /home/myusername/emulationstation-de/emulationstation-de-1.0.0-x64.rpm generated.
```
On Fedora, you need to install rpmbuild before this command can be run though: On Fedora, you need to install rpmbuild before this command can be run though:
``` ```
@ -407,6 +423,15 @@ cmake .
make make
``` ```
By default the master branch will be used, which is where the development takes place. To instead build the latest stable release, switch to the `stable` branch:
```
cd emulationstation-de
git checkout stable
cmake .
make
```
To generate a debug build, run this instead: To generate a debug build, run this instead:
``` ```
cmake -DCMAKE_BUILD_TYPE=Debug . cmake -DCMAKE_BUILD_TYPE=Debug .
@ -765,6 +790,13 @@ This works the same as on Unix or macOS, just run the following:
git clone https://gitlab.com/leonstyhre/emulationstation-de.git git clone https://gitlab.com/leonstyhre/emulationstation-de.git
``` ```
By default the master branch will be used, which is where the development takes place. To instead build the latest stable release, switch to the `stable` branch:
```
cd emulationstation-de
git checkout stable
```
**Setup the include directories:** **Setup the include directories:**
As there is no standardized include directory structure in Windows, you need to provide the include files manually. As there is no standardized include directory structure in Windows, you need to provide the include files manually.

View file

@ -115,6 +115,15 @@ cmake .
make make
``` ```
By default the master branch will be used, which is where the development takes place. To instead build the latest stable release, switch to the `stable` branch:
```
cd emulationstation-de
git checkout stable
cmake .
make
```
To create a debug build, run this instead: To create a debug build, run this instead:
``` ```
cmake -DCMAKE_BUILD_TYPE=Debug . cmake -DCMAKE_BUILD_TYPE=Debug .
@ -407,6 +416,15 @@ cmake .
make make
``` ```
By default the master branch will be used, which is where the development takes place. To instead build the latest stable release, switch to the `stable` branch:
```
cd emulationstation-de
git checkout stable
cmake .
make
```
To generate a debug build, run this instead: To generate a debug build, run this instead:
``` ```
cmake -DCMAKE_BUILD_TYPE=Debug . cmake -DCMAKE_BUILD_TYPE=Debug .
@ -765,6 +783,13 @@ This works the same as on Unix or macOS, just run the following:
git clone https://gitlab.com/leonstyhre/emulationstation-de.git git clone https://gitlab.com/leonstyhre/emulationstation-de.git
``` ```
By default the master branch will be used, which is where the development takes place. To instead build the latest stable release, switch to the `stable` branch:
```
cd emulationstation-de
git checkout stable
```
**Setup the include directories:** **Setup the include directories:**
As there is no standardized include directory structure in Windows, you need to provide the include files manually. As there is no standardized include directory structure in Windows, you need to provide the include files manually.