Bläddra i källkod

Update build instructions

Make build instructions concise.
master
TheoryOfNekomata 1 år sedan
förälder
incheckning
dfe9a7e6b7
3 ändrade filer med 71 tillägg och 20 borttagningar
  1. +9
    -1
      00-build-cache-debug-x64
  2. +10
    -1
      00-build-cache-debug-x64.bat
  3. +52
    -18
      README.md

+ 9
- 1
00-build-cache-debug-x64 Visa fil

@@ -1,3 +1,11 @@
#!/usr/bin/env sh

cmake -DPROJECT_SOURCE_DIR=. -DCMAKE_SIZEOF_VOID_P=8 -DCMAKE_BUILD_TYPE=Debug -DCMAKE_MAKE_PROGRAM=ninja -DCMAKE_C_COMPILER=cc -DCMAKE_C_COMPILER_WORKS=1 -DCMAKE_C_FLAGS=-m64 -G Ninja -S . -B ./build/Debug
cmake \
-DCMAKE_SIZEOF_VOID_P=8 \
-DCMAKE_BUILD_TYPE=Debug \
-DCMAKE_MAKE_PROGRAM=ninja \
-DCMAKE_C_COMPILER=cc \
-DCMAKE_C_FLAGS=-m64 \
-G Ninja \
-S . \
-B ./build/Debug

+ 10
- 1
00-build-cache-debug-x64.bat Visa fil

@@ -1 +1,10 @@
cmake -DPROJECT_SOURCE_DIR=. -DCMAKE_SIZEOF_VOID_P=8 "-DCMAKE_MT=%CMAKE_MT%" -DCMAKE_BUILD_TYPE=Debug -DCMAKE_MAKE_PROGRAM=ninja -DCMAKE_C_COMPILER=clang-cl -DCMAKE_C_COMPILER_WORKS=1 -DCMAKE_C_FLAGS=-m64 -G Ninja -S . -B ./build/Debug
cmake \
-DCMAKE_SIZEOF_VOID_P=8 \
"-DCMAKE_MT=%CMAKE_MT%" \
-DCMAKE_BUILD_TYPE=Debug \
-DCMAKE_MAKE_PROGRAM=ninja \
-DCMAKE_C_COMPILER=clang-cl \
-DCMAKE_C_FLAGS=-m64 \
-G Ninja \
-S . \
-B ./build/Debug

+ 52
- 18
README.md Visa fil

@@ -4,41 +4,75 @@ A run-and-gun shooter inspired by Metal Slug and Counter-Strike.

## Setup

The following tools are required:
For Windows, it is recommended to use [Chocolatey](https://community.chocolatey.org) for retrieving the required tools. Use [Homebrew](https://brew.sh) for macOS instead.

For *NIX, use whatever dependency manager you prefer.

The following are required for building on all platforms:

* CMake
* Ninja
* Clang
* [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/) (Windows)
* `autoconf` (macOS/*NIX)
* `make` (macOS/*NIX)
* `libtool` (*NIX)

For Windows and macOS, it is recommended to use Chocolatey and Homebrew respectively, for retrieving the required tools.

For *NIX, use whatever dependency manager you prefer to obtain the needed tools.

### Windows

1. Ensure your environment variables are set up.
1. Install the [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/).
2. Ensure your environment variables are set up.

> **Important:** Set your `CC` environment variable to the full path of `clang-cl.exe`

> **Important:** Set your `CMAKE_MT` environment variable to the full path of `mt.exe`, which can be found on your
> Windows SDK installation folder (usually `C:/Program Files (x86)/Windows Kits/10/bin/10.0.19041.0/x86/mt.exe`)

2. Clone this repo recursively.
3. Build the dependencies under `subprojects`. Follow the instructions on building for Visual C.
3. Clone this repo recursively.
4. Build the dependencies under `subprojects`. Follow the instructions on building for Visual C.

> **Important:** For `libwebsockets`, follow the [instructions on building LWS](https://libwebsockets.org/lws-api-doc-master/html/md_README_8build.html).

4. Generate the CMake cache.
5. Build the specific executables you want to build, which are defined in `CMakeLists.txt`.
5. Generate the CMake cache.

```shell
cmake \
-DCMAKE_SIZEOF_VOID_P=8 \
"-DCMAKE_MT=%CMAKE_MT%" \
"-DCMAKE_BUILD_TYPE=%BUILD_TYPE%" \
-DCMAKE_MAKE_PROGRAM=ninja \
-DCMAKE_C_COMPILER=clang-cl \
-DCMAKE_C_FLAGS=-m64 \
-G Ninja \
-S . \
-B "./build/%BUILD_TYPE%"
```
> **Important:** Create the directories under `/build` per each `BUILD_TYPE` you are generating.

6. Build the specific executables you want to build, which are defined in `CMakeLists.txt`.

### macOS/*NIX

1. Clone this repo recursively.
2. Build the dependencies under `subprojects`. Follow the instructions on building for *NIX (macOS should have similar
1. Ensure additional tools are present in the system:

* `autoconf`
* `make`
* `libtool` (*NIX only)

2. Clone this repo recursively.
3. Build the dependencies under `subprojects`. Follow the instructions on building for *NIX (macOS should have similar
instructions for *NIX).
3. Generate the CMake cache.
4. Build the specific executables you want to build, which are defined in `CMakeLists.txt`.
4. Generate the CMake cache.

```shell
cmake \
-DCMAKE_SIZEOF_VOID_P=8 \
-DCMAKE_BUILD_TYPE=$BUILD_TYPE \
-DCMAKE_MAKE_PROGRAM=ninja \
-DCMAKE_C_COMPILER=cc \
-DCMAKE_C_FLAGS=-m64 \
-G Ninja \
-S . \
-B ./build/$BUILD_TYPE
```

> **Important:** Create the directories under `/build` per each `BUILD_TYPE` you are generating.
5. Build the specific executables you want to build, which are defined in `CMakeLists.txt`.

Laddar…
Avbryt
Spara