Merge pull request #41 from ArbestRiAgain/readme

Big README update
This commit is contained in:
georgemoralis 2023-09-29 06:26:41 +03:00 committed by GitHub
commit 739fa266ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions

View File

@ -1,15 +1,15 @@
# shadPS4
An early PS4 emulator for Windows and Linux
An early PS4 emulator for Windows and Linux written in C++
[Check us on twitter](https://twitter.com/shadps4 "Check us on twitter")
# Status
Currently it can only load PS4 ELF files.
Currently, it can only load PS4 ELF files.
Progress is focus on videoout_basic.elf from sdk demos , currently it can load and run a few HLE calls. Others probably won't run since they might not be able to relocate all neccesary functions
Progress is focused on videoout_basic.elf from SDK demos, currently, it can load with fully working graphics. Others probably won't run since they might not be able to relocate all necessary functions
![](https://geps.dev/progress/60) Elf Loader
@ -19,7 +19,7 @@ Progress is focus on videoout_basic.elf from sdk demos , currently it can load a
# Why?
The project started as a fun project. Due to short amount of free time probably it will take a while since it will be able to run something decent but I am trying to do regular small commits.
The project started as a fun project. Due to short free time, it will probably take a while since it will be able to run something decent, but I am trying to do regular small commits.
# Build
@ -37,7 +37,7 @@ Check building instructions in [linux build](https://github.com/georgemoralis/sh
|--------|------------|
|Windows build|[![Windows](https://github.com/georgemoralis/shadPS4/actions/workflows/windows.yml/badge.svg)](https://github.com/georgemoralis/shadPS4/actions/workflows/windows.yml)
To discuss this emulator please join our Discord server: [![Discord](https://img.shields.io/discord/1080089157554155590)](https://discord.gg/MyZRaBngxA)
To discuss the development of this emulator, please join our Discord server: [![Discord](https://img.shields.io/discord/1080089157554155590)](https://discord.gg/MyZRaBngxA)
# Who are you?
@ -51,9 +51,9 @@ Old emulator fans and devs can recognize me as "shadow". I was the founder and c
# Contribution
I currently accept any kind of contribution, here is a list of some items that may be useful:
I currently accept any contribution, here is a list of some items that may be useful:
* PKG extractor (there was an initial work on this, just search project history commits).
* PKG extractor (there was initial work on this, search project history commits).
* Initial GUI with imgui, SDL3 and Vulkan.
* to be filled...
@ -65,4 +65,4 @@ Wiki has some documentation for PS4 PKG format
# 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 , multiplatfrom emulator (chip-8,GB,NES,N64) from paris
- [hydra](https://github.com/hydra-emu/hydra): An multisystem , multiplatform emulator (chip-8,GB,NES,N64) from Paris