Skip to content

Commit

Permalink
Readme: improvements (shadps4-emu#121)
Browse files Browse the repository at this point in the history
* Update README.md

* Minor fixes

* Update building-windows.md

* Update linux_building.md

* Update readme.txt

* Build status

* Add psucien
  • Loading branch information
Xphalnos authored May 3, 2024
1 parent ce4bdee commit 235b6e8
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 40 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,29 @@ SPDX-License-Identifier: GPL-2.0-or-later

# shadPS4

An early PS4 emulator for Windows and Linux written in C++
by shadow , skmp , wheremyfoodat , GPUCode
shadPS4 is an early PS4 emulator for Windows and Linux written in C++

[Check us on twitter](https://twitter.com/shadps4 "Check us on twitter")
To discuss shadPS4 development or suggest ideas, join the [Discord server](https://discord.gg/MyZRaBngxA)

Check us on [twitter](https://twitter.com/shadps4)

# Status

Early progress , a small amount of ps4 sdk demos and homebrew games working
Early progress, a small amount of PS4 SDK demos and homebrew games working.

# Why?

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.
The project started as a fun project. Due to limited free time, it will probably take a while before shadPS4 is able to run anything decent, but we're trying to make small, regular commits.

# Build

## Windows

Check building instructions in [windows build](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-windows.md)
Check building instructions in [Windows build](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 building instructions in [Linux build](https://github.com/shadps4-emu/shadPS4/blob/main/documents/linux_building.md)

## Build status

Expand All @@ -35,23 +36,22 @@ Check building instructions in [linux build](https://github.com/shadps4-emu/shad
|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)
|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)

To discuss the development of this emulator, please join our Discord server: [![Discord](https://img.shields.io/discord/1080089157554155590)](https://discord.gg/MyZRaBngxA)

# Main team

- gmoralis (a.k.a. shadow)
- gpucode (a.k.a. emufan4568)
- skmp (a.k.a. drk||Raziel)
- wheremyfoodat (a.k.a. rodakinos)
- raziel1000
- [georgemoralis](https://github.com/georgemoralis)
- [raphaelthegreat](https://github.com/raphaelthegreat)
- [psucien](https://github.com/psucien)
- [skmp](https://github.com/skmp)
- [wheremyfoodat](https://github.com/wheremyfoodat)
- [raziel1000](https://github.com/raziel1000)

Logo is done by Xphalnos
Logo is done by [Xphalnos](https://github.com/Xphalnos)

# Contribution

We currently accept any contribution, just open a pr and we will check it :)

We currently accept any contribution, just open a PR and we will check it :)

# 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
- [hydra](https://github.com/hydra-emu/hydra): An multisystem, multiplatform emulator (chip-8,GB,NES,N64) from Paris
16 changes: 8 additions & 8 deletions documents/building-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@ SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project
SPDX-License-Identifier: GPL-2.0-or-later
-->

# How to build shadps4 in windows
# Build shadps4 for Windows

## Download VStudio Community 2022 17.9.5
## Download Visual Studio Community 2022 17.9.6

[VStudio 2022](https://visualstudio.microsoft.com/vs/)
Download link: [Visual Studio 2022](https://visualstudio.microsoft.com/vs/)

## Requirements

Install the following
### From Visual Studio Community

- Desktop development with c++
- Desktop development with C++

### From Individual components tab install
### From individual components tab install

- C++ Clang Compiler for Windows (17.0.3)
- MSBuild support for LLVM (clang-cl) toolset
- MSBuild support for LLVM (Clang-cl) toolset

- ## Compiling

- Open vstudio and select the clang debug or clang release . It should compile just fine
- Open Visual Studio and select the Clang-debug or Clang-release. It should compile just fine.
2 changes: 1 addition & 1 deletion documents/linux_building.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project
SPDX-License-Identifier: GPL-2.0-or-later
-->

## Linux
## Build shadPS4 for Linux

Generate the build directory in the shadPS4 directory:
```
Expand Down
24 changes: 11 additions & 13 deletions documents/readme.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
shadps4 - An ps4 emulator
shadPS4 - A PS4 emulator
=========================

1. Intro
Expand All @@ -8,30 +8,28 @@ shadps4 - An ps4 emulator

1.Intro
=======
shadPS4 is a ps4 emulator for windows and linux . Although atm it can't run a lot of stuff , we are working torwards to make it more compatible
shadPS4 is a Play Station 4 emulator for Windows and Linux. Although atm it can't run a lot of stuff, we are working torwards to make it more compatible.

2.Current status
================
shadps4 is a HLE emulator . Currently on a small amount of functions is emulated , which is one of the reasons compatibility is low.

shadPS4 is a HLE emulator. Currently on a small amount of functions is emulated, which is one of the reasons compatibility is low.

3.Contributors
==============
- gmoralis (a.k.a. shadow)
- gpucode (a.k.a. emufan4568)
- skmp (a.k.a. drk||Raziel)
- wheremyfoodat (a.k.a. rodakinos)
- georgemoralis
- raphaelthegreat
- skmp
- wheremyfoodat

4.Greetings
===========
I would like to thank the following people for helping me so far , with coding or moral support.
I would like to thank the following people for helping me so far, with coding or moral support.

- wheremyfoodat - or @rodakinos for believed me.
- wheremyfoodat - or @rodakinos for believed me
- paris - or OFFTKP for not believing me and that made me a better coder :D
- skmp - or kornilios for being good old friend
- PandaBad - our beloved stalker
- emufan4568 - for advices
- velocity - for talking 1-2 times per year on discord server . We miss you velocity

- probably more , will include in the next readme :D
- velocity - for talking 1-2 times per year on discord server. We miss you velocity

- probably more, will include in the next readme :D

0 comments on commit 235b6e8

Please sign in to comment.