EventHorizonStudio/EHS
EventHorizonStudio/EHS
3
0
Fork 0
Code Issues 8 Pull Requests Actions Packages Projects 1 Releases 7 Wiki Activity

Adjusted readme.
Some checks failed
Build & Release / Windows-AMD64-Build (push) Has been cancelled
Details
Build & Release / Linux-AARCH64-Build (push) Has been cancelled
Details
Build & Release / Linux-AMD64-Build (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Arron David Nelson 2024-02-05 22:44:22 -08:00
parent 6f783c4ea2
commit 055f6e173e
1 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -44,38 +44,40 @@ This project does not fully follow the C++ standard.
- Windows
- Linux
# Compiling
## Prerequisites
### Linux
# Compiling/Building/Installing
## Linux
### Prerequisites
- **Arch Linux**: `sudo pacman -S gcc nasm cmake alsa-lib libxcb xcb-util-cursor`
- **Debian Linux**: `sudo apt install gcc nasm cmake libasound2-dev libxcb1-dev libxcb-xinput-dev libxcb-cursor-dev`
For building on the Raspberry Pi instead of the Netwide Assembler (NASM), GCC's Assembler is used.
### Windows
### Building
`cmake -DCMAKE_BUILD_TYPE=Release -DLINUX_WINDOW_SYSTEM:STRING=XCB /path/to/source`
The `LINUX_WINDOW_SYSTEM` variable in the first step can be either `XCB` for the X Window System or `Wayland` for the
Wayland Window System. Wayland support is currently not fully supported yet, use only `XCB`.
### Compiling
`cmake --build /path/to/build --config Release`
### Installing
`sudo cmake --install . --prefix /usr/local`
## Windows
### Prerequisites
- [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/)
- [Netwide Assembler](https://www.nasm.us/)
- [CMake](https://cmake.org/)
- [vcpkg](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started?pivots=shell-cmd)
## Building
### Linux
1. `cmake -DCMAKE_BUILD_TYPE=Release -DLINUX_WINDOW_SYSTEM:STRING=XCB /path/to/source`
2. `cmake --build /path/to/build --config Release`
### Building
`cmake -A x64 -DCMAKE_BUILD_TYPE=Release --preset=default .`
The `LINUX_WINDOW_SYSTEM` variable in the first step can be either `XCB` for the X Window System or `Wayland` for the
Wayland Window System. Wayland support is currently not fully supported yet, use only `XCB`.
### Compiling
`cmake --build build --config Release`
### Windows
1. `cmake -A x64 -DCMAKE_BUILD_TYPE=Release --preset=default .`
2. `cmake --build build --config Release`
## Installing
### Linux
`sudo cmake --install . --prefix /usr/local`
### Windows
### Installing
`cmake --install . --prefix "C:/Program Files/EHS"`
This will require the terminal to be running in administrator mode.