diff --git a/.reuse/dep5 b/.reuse/dep5 index 792b6f60..69e066f5 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -9,8 +9,8 @@ Files: CMakeSettings.json .github/shadps4.desktop .github/shadps4.png .gitmodules + documents/Screenshots/screenshot.png src/images/shadps4.ico - screenshots/screenshot.png src/images/controller_icon.png src/images/exit_icon.png src/images/file_icon.png diff --git a/README.md b/README.md index f9f931ec..30652035 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,46 @@ SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project SPDX-License-Identifier: GPL-2.0-or-later --> +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
# shadPS4
shadPS4 is an early PS4 emulator for Windows and Linux written in C++
-[![Video](http://img.youtube.com/vi/AAHoNzhHyCU/0.jpg)](https://www.youtube.com/watch?v=AAHoNzhHyCU)
-
To discuss shadPS4 development or suggest ideas, join the [Discord server](https://discord.gg/MyZRaBngxA)
-Check us on [X (twitter)](https://x.com/shadps4)
+Check us on [X (twitter)](https://x.com/shadps4) or on our [website](https://shadps4.net/).
# Status
-Early progress, a small amount of PS4 SDK demos and homebrew games working.
+In development, 2D games are working like [Sonic Mania](https://www.youtube.com/watch?v=AAHoNzhHyCU), Undertale, Momodora and others...
# Why?
@@ -25,18 +52,21 @@ The project started as a fun project. Due to limited free time, it will probably
## Windows
-Check building instructions in [Windows build](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-windows.md)
+Check the build instructions for [Windows](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-windows.md).
## Linux
-Check building instructions in [Linux build](https://github.com/shadps4-emu/shadPS4/blob/main/documents/linux_building.md)
+Check the build instructions for [Linux](https://github.com/shadps4-emu/shadPS4/blob/main/documents/linux_building.md).
## Build status
-|Platform|Build status|
+|Windows|Build status|
|--------|------------|
|Windows SDL Build|[![Windows-sdl](https://github.com/shadps4-emu/shadPS4/actions/workflows/windows.yml/badge.svg)](https://github.com/shadps4-emu/shadPS4/actions/workflows/windows.yml)
|Windows Qt Build|[![Windows-qt](https://github.com/shadps4-emu/shadPS4/actions/workflows/windows-qt.yml/badge.svg)](https://github.com/shadps4-emu/shadPS4/actions/workflows/windows-qt.yml)
+
+|Linux|Build status|
+|--------|------------|
|Linux SDL Build|[![Linux-sdl](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux.yml/badge.svg)](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux.yml)
|Linux Qt Build|[![Linux-qt](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux-qt.yml/badge.svg)](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux-qt.yml)
@@ -62,7 +92,13 @@ Logo is done by [Xphalnos](https://github.com/Xphalnos)
We currently accept any contribution, just open a PR and we will check it :)
+# Contributors
+
+
+
+
+
# Sister Projects
-- [Panda3DS](https://github.com/wheremyfoodat/Panda3DS): An multiplatform 3DS emulator from our co-author wheremyfoodat
-- [hydra](https://github.com/hydra-emu/hydra): An multisystem, multiplatform emulator (chip-8,GB,NES,N64) from Paris
+- [Panda3DS](https://github.com/wheremyfoodat/Panda3DS): A multiplatform 3DS emulator from our co-author wheremyfoodat.
+- [hydra](https://github.com/hydra-emu/hydra): A multisystem, multiplatform emulator (chip-8, GB, NES, N64) from Paris.
diff --git a/documents/Screenshots/screenshot.png b/documents/Screenshots/screenshot.png
new file mode 100644
index 00000000..cfcdb703
Binary files /dev/null and b/documents/Screenshots/screenshot.png differ