Skip to content

Commit c7e1f4a

Browse files
committed
readme: redo the CI badges, fix Web link and reword things a bit
1 parent 88d795b commit c7e1f4a

1 file changed

Lines changed: 21 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,37 @@
33
Dæmon is the standalone game engine that powers the multiplayer first person shooter [Unvanquished](https://unvanquished.net).
44

55
[![GitHub tag](https://img.shields.io/github/tag/DaemonEngine/Daemon.svg)](https://github.com/DaemonEngine/Daemon/tags)
6-
[![Web](https://img.shields.io/badge/web-unvanquished.net-ffaaaa)](https://forums.unvanquished.net)
6+
[![Web](https://img.shields.io/badge/web-unvanquished.net-ffaaaa)](https://unvanquished.net)
77
[![Forums](https://img.shields.io/badge/forums-forums.unvanquished.net-ffaaaa)](https://forums.unvanquished.net)
88
[![Wiki](https://img.shields.io/badge/wiki-wiki.unvanquished.net_%E2%80%A3_Dæmon_Engine-ffaaaa)](https://wiki.unvanquished.net/wiki/Daemon)
99
[![Rules](https://img.shields.io/badge/chat-rules-ffdd00)](https://wiki.unvanquished.net/wiki/Chat#Rules)
1010
[![IRC](https://img.shields.io/badge/irc-%23unvanquished%2C%23unvanquished--dev-9cf.svg)](https://unvanquished.net/chat/)
1111
[![Matrix](https://img.shields.io/badge/matrix-Unvanquished-9cf?logo=matrix)](https://matrix.to/#/!WnuetRiQZJNBTKwMrF:matrix.org?via=matrix.org)
1212
[![Discord](https://img.shields.io/badge/discord-Unvanquished-9cf?logo=discord)](https://discord.gg/usuDT9Pyna)
1313

14+
## Validation
15+
16+
Target & compiler|Build status|Target & compiler|Build status
17+
-|-|-|-
18+
<sub>Linux amd64 GCC</sub>|[![Build Status](https://img.shields.io/github/check-runs/DaemonEngine/Daemon/master?nameFilter=Linux%20amd64%20GCC)](https://github.com/DaemonEngine/Daemon/actions/workflows/build_test.yml?query=branch%3Amaster)|<sub>Windows amd64 MSVC</sub>|[![Build status](https://ci.appveyor.com/api/projects/status/github/DaemonEngine/Daemon?banch=master&svg=true)](https://ci.appveyor.com/project/DolceTriade/Daemon/history)
19+
<sub>Linux amd64 Clang</sub>|[![Build Status](https://img.shields.io/github/check-runs/DaemonEngine/Daemon/master?nameFilter=Linux%20amd64%20Clang)](https://github.com/DaemonEngine/Daemon/actions/workflows/build_test.yml?query=branch%3Amaster)|<sub>Windows amd64 MinGW</sub>|[![Build Status](https://img.shields.io/github/check-runs/DaemonEngine/Daemon/master?nameFilter=Windows%20amd64%20MinGW)](https://github.com/DaemonEngine/Daemon/actions/workflows/build_test.yml?query=branch%3Amaster)
20+
<sub>macOS amd64 AppleClang</sub>|[![Build Status](https://img.shields.io/github/check-runs/DaemonEngine/Daemon/master?nameFilter=macOS%20amd64%20AppleClang)](https://github.com/DaemonEngine/Daemon/actions/workflows/build_test.yml?query=branch%3Amaster)|<sub>CodeQL C++ static analysis</sub>|[![Build Status](https://img.shields.io/github/check-runs/DaemonEngine/Daemon/master?nameFilter=Analyze%20%28c-cpp%29)](https://github.com/DaemonEngine/Daemon/actions/workflows/codeql.yml?query=branch%3Amaster)
21+
22+
## Onboarding
23+
1424
ℹ️ We provide ready-to-use downloads for the Unvanquished game on the [Unvanquished download page](https://unvanquished.net/download/), builds of the Dæmon engine are included.
1525

1626
ℹ️ The Unvanquished game logic source code can be found there: [github.com/Unvanquished/Unvanquished](https://github.com/Unvanquished/Unvanquished).
1727

28+
💡️ Building this engine is enough to play the game and join servers once you [download the game's assets](https://github.com/Unvanquished/Unvanquished#downloading-the-games-assets).
29+
30+
💡️ You need to build this repository if you want to contribute to the engine code (not the game logic).
31+
32+
See below for [build](#building-the-engine-binaries) and [launch](#running-a-game) instructions.
33+
34+
If you are interested in creating or using Unvanquished packages for package managers, see
35+
[wiki:Linux packages](https://wiki.unvanquished.net/wiki/Linux_packages).
36+
1837
## Workspace requirements
1938

2039
To fetch and build Dæmon, you'll need:
@@ -73,7 +92,7 @@ git submodule update --init --recursive
7392

7493
ℹ️ If cmake complains about missing files in `libs/crunch/` folder or similar issue then you have skipped this step.
7594

76-
## Build Instructions
95+
## Building the engine binaries
7796

7897
💡️ Instead of `-j4` you can use `-jN` where `N` is your number of CPU cores to distribute compilation on them. Linux systems usually provide a handy `nproc` tool that tells the number of CPU core so you can just do `-j$(nproc)` to use all available cores.
7998

0 commit comments

Comments
 (0)