Skip to content

Commit f1081a5

Browse files
Update README.md
1 parent 50bfd74 commit f1081a5

1 file changed

Lines changed: 10 additions & 38 deletions

File tree

README.md

Lines changed: 10 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
I'll update your README.md with all the requested changes. Here's the complete updated version:
2-
3-
```markdown
41
# OmniChess
52

63
An open-source chess game built entirely in Python — play against Stockfish, a friend, or tackle Lichess puzzles. **Now available as BOTH a desktop application AND a web version (zero install)!**
@@ -62,6 +59,8 @@ Play instantly in your browser — no installation required!
6259

6360
---
6461

62+
---
63+
6564
## 🚀 Installation
6665

6766
Choose your platform below.
@@ -236,8 +235,6 @@ wget -qO- https://raw.githubusercontent.com/Coder787-source/OmniChess/main/unins
236235

237236
## 📋 Requirements
238237

239-
### Desktop Version
240-
241238
| Requirement | Details |
242239
|---|---|
243240
| Python | 3.8+ — [python.org/downloads](https://www.python.org/downloads/) |
@@ -246,45 +243,21 @@ wget -qO- https://raw.githubusercontent.com/Coder787-source/OmniChess/main/unins
246243
| Symbola font | Linux only — `sudo apt install fonts-symbola` |
247244
| Stockfish | Download from [stockfishchess.org](https://stockfishchess.org/download/) |
248245

249-
### Web Version
250-
251-
| Requirement | Details |
252-
|---|---|
253-
| Browser | Any modern browser (Chrome, Firefox, Safari, Edge) |
254-
| Internet | Required for gameplay |
255-
| JavaScript | Must be enabled |
256-
257246
---
258247

259-
## 📱 Supported Platforms
248+
## 🔧 Unsupported Operating Systems
260249

261-
### Desktop (Officially Tested)
262-
- **Windows 10/11** — x86-64 & ARM64
263-
- **Linux** — x86-64 & ARM/Raspberry Pi
264-
- **macOS** — Apple Silicon & Intel
250+
OmniChess is officially tested and supported only on **Windows 10/11 (x86-64 & ARM64)**, **Linux (x86-64 & ARM/Raspberry Pi)**, and **macOS (Apple Silicon & Intel)**.
265251

266-
### Web (Works Anywhere)
267-
- **ChromeOS** — No Linux container needed, runs directly in Chrome
268-
- **Windows/Mac/Linux** — No installation required
269-
- **School/work computers** — Works without admin rights
270-
- **Mobile devices** — Play on tablets and phones with a browser
252+
You are welcome to try running OmniChess on other operating systems — including **Windows 8, 8.1, ChromeOS, FreeBSD, or older macOS versions** — but it will **not be officially supported**. If you choose to do so:
271253

272-
---
273-
274-
## 🔧 Unsupported Operating Systems (Desktop Only)
275-
276-
OmniChess Desktop is **not officially supported** on the following platforms:
277-
278-
- **Windows 8 / 8.1** — Python 3.8+ and modern pygame versions may not function correctly
279-
- **FreeBSD** — Stockfish compilation and pygame compatibility issues likely
280-
- **Older macOS versions** — Pre-Catalina systems may have compatibility problems
281-
282-
> 💡 **ChromeOS users**: Instead of using the Linux container (which has Wayland, audio, and input limitations), we strongly recommend using the **[Web Version](https://coder787-source.github.io/OmniChess/)** for the best experience.
283-
284-
If you choose to run the desktop version on unsupported platforms:
285254
- ⚠️ **No technical support** will be provided for installation or runtime issues
286255
- ⚠️ **Stockfish compilation** may fail or require significant manual tweaking
287256
- ⚠️ **Pygame and python-chess** may have compatibility problems
257+
- ⚠️ **Windows 8/8.1** users: Python 3.8+ and modern pygame versions may not function correctly
258+
- ⚠️ **ChromeOS** users: Linux container limitations (Wayland, audio, input) can cause unpredictable behaviour
259+
260+
> 💡 **Recommendation**: For the best experience, use one of the officially supported platforms listed above.
288261
289262
---
290263

@@ -297,5 +270,4 @@ If you choose to run the desktop version on unsupported platforms:
297270
---
298271

299272
## 📰 Featured In
300-
- [Outskirts Forum](https://outskirts.altervista.org/forum/viewtopic.php?t=6053)
301-
```
273+
- [Outskirts Forum](https://outskirts.altervista.org/forum/viewtopic.php?t=6053)

0 commit comments

Comments
 (0)