From 055f6e173e57d84b370aeca9657a11a04e3cca3f Mon Sep 17 00:00:00 2001 From: Karutoh Date: Mon, 5 Feb 2024 22:44:22 -0800 Subject: [PATCH] Adjusted readme. --- README.md | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index e85f8c0..c346c50 100644 --- a/README.md +++ b/README.md @@ -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.