From a5bcfb53589a27e71f4332c97c3a0b96d051f426 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maksymilian=20Wilczy=C5=84ski?= <maksw@maksw.pl>
Date: Sun, 1 Sep 2024 14:54:22 +0200
Subject: [PATCH] enhance readme

---
 README.md | 72 +++++++++++++++++++------------------------------------
 1 file changed, 25 insertions(+), 47 deletions(-)

diff --git a/README.md b/README.md
index 95af56707..e751488a9 100644
--- a/README.md
+++ b/README.md
@@ -1,55 +1,33 @@
-# Source Engine
-[![GitHub Actions Status](https://github.com/nillerusr/source-engine/actions/workflows/build.yml/badge.svg)](https://github.com/nillerusr/source-engine/actions/workflows/build.yml) [![GitHub Actions Status](https://github.com/nillerusr/source-engine/actions/workflows/tests.yml/badge.svg)](https://github.com/nillerusr/source-engine/actions/workflows/tests.yml)
- Discord: [![Discord Server](https://img.shields.io/discord/672055862608658432.svg)](https://discord.gg/hZRB7WMgGw)
- 
-# This is a fork of nillerusr's port.
-## i like to experiment on here, don't use this for anything serious
-this fork contains contains:
-1. player shadows
-2. increased edict limit
-3. drawviewmodel no longer a cheat
-4. increased number of projected textures
-
-Information from [wikipedia](https://wikipedia.org/wiki/Source_(game_engine)):
-
-Source is a 3D game engine developed by Valve.
-It debuted as the successor to GoldSrc with Half-Life: Source in June 2004,
-followed by Counter-Strike: Source and Half-Life 2 later that year.
-Source does not have a concise version numbering scheme; instead, it was released in incremental versions
+# Source Engine fork based on nillerusr
+[![GitHub Actions Status](https://github.com/maksw2/source-engine/actions/workflows/build.yml/badge.svg)](https://github.com/maksw2/source-engine/actions/workflows/build.yml) [![GitHub Actions Status](https://github.com/maksw2/source-engine/actions/workflows/tests.yml/badge.svg)](https://github.com/nillerusr/source-engine/actions/workflows/tests.yml)
 
 Source code is based on TF2 2018 leak. Don't use it for commercial purposes.
 
 This project is using waf buildsystem. If you have waf-related questions look https://waf.io/book
 
 # Features:
-- Android, OSX, FreeBSD, Windows, Linux( glibc, musl ) support
-- Arm support( except windows )
-- 64bit support
-- Modern toolchains support
-- Fixed many undefined behaviours
-- Touch support( even on windows/linux/osx )
-- VTF 7.5 support
-- PBR support
-- bsp v19-v21 support( bsp v21 support is partial, portal 2 and csgo maps works fine )
-- mdl v46-49 support
-- Removed useless/unnecessary dependencies
-- Achivement system working without steam
-- Fixed many bugs
-- Serverbrowser works without steam
-
-# Current tasks
-- Rewrite materialsystem for OpenGL render
-- dxvk-native support
-- Elbrus port
-- Bink audio support( for video_bink )
+- [x] Android, OSX, FreeBSD, Windows, Linux( glibc, musl ) support  
+- [x] Arm support  
+- [x] 64bit support  
+- [x] Modern toolchains support  
+- [x] Fixed many undefined behaviours  
+- [x] Touch support( even on windows/linux/osx )  
+- [x] VTF 7.5 support  
+- [x] PBR support  
+- [x] bsp v19-v21 support( bsp v21 support is partial, portal 2 and csgo maps works fine )  
+- [x] mdl v46-49 support  
+- [x] Removed useless/unnecessary dependencies   
+- [x] Fixed many bugs  
+- [x] Achivement system working without steam  
+- [x] Serverbrowser works without steam  
+- [x] Player model and shadows in first person  
+- [x] Increased many limits  
+- [x] cl_drawviewmodel no longer a cheat  
+- [x] Increased number of projected textures  
+- [ ] Rewrite materialsystem for OpenGL render  
+- [ ] dxvk-native support  
+- [ ] Elbrus port  
+- [ ] Bink audio support( for video_bink )  
 
 # How to Build?
-- [Building instructions(EN)](https://github.com/nillerusr/source-engine/wiki/Source-Engine-(EN))
-- [Building instructions(RU)](https://github.com/nillerusr/source-engine/wiki/Source-Engine-(RU))
-
-# Support me
-BTC: `bc1qnjq92jj9uqjtafcx2zvnwd48q89hgtd6w8a6na`
-
-ETH: `0x5d0D561146Ed758D266E59B56e85Af0b03ABAF46`
-
-XMR: `48iXvX61MU24m5VGc77rXQYKmoww3dZh6hn7mEwDaLVTfGhyBKq2teoPpeBq6xvqj4itsGh6EzNTzBty6ZDDevApCFNpsJ`
+- [Building instructions(EN)](https://github.com/maksw2/source-engine/wiki/Building-instructions)