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

This commit is contained in:
Arron David Nelson 2024-02-05 22:37:30 -08:00
parent bcd71cf2b5
commit 6f783c4ea2

View File

@ -47,18 +47,18 @@ This project does not fully follow the C++ standard.
# Compiling # Compiling
## Prerequisites ## Prerequisites
### Windows
- [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)
### Linux ### Linux
- **Arch Linux**: `sudo pacman -S gcc nasm cmake alsa-lib libxcb xcb-util-cursor` - **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` - **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. For building on the Raspberry Pi instead of the Netwide Assembler (NASM), GCC's Assembler is used.
### Windows
- [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 ## Building
### Linux ### Linux
1. `cmake -DCMAKE_BUILD_TYPE=Release -DLINUX_WINDOW_SYSTEM:STRING=XCB /path/to/source` 1. `cmake -DCMAKE_BUILD_TYPE=Release -DLINUX_WINDOW_SYSTEM:STRING=XCB /path/to/source`
@ -71,6 +71,15 @@ Wayland Window System. Wayland support is currently not fully supported yet, use
1. `cmake -A x64 -DCMAKE_BUILD_TYPE=Release --preset=default .` 1. `cmake -A x64 -DCMAKE_BUILD_TYPE=Release --preset=default .`
2. `cmake --build build --config Release` 2. `cmake --build build --config Release`
## Installing
### Linux
`sudo cmake --install . --prefix /usr/local`
### Windows
`cmake --install . --prefix "C:/Program Files/EHS"`
This will require the terminal to be running in administrator mode.
# Simple Example # Simple Example
```cpp ```cpp
#include <ehs/EHS.h> #include <ehs/EHS.h>