Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hteumeuleu committed Apr 5, 2023
1 parent 413e5e4 commit e6a3f70
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,23 @@

# Celeste Classic

A port of Celeste Classic from PICO-8 to Playdate. The game is currently in beta.
A port of Celeste Classic from PICO-8 to Playdate.

## How to play

1. Download the latest release at https://github.com/hteumeuleu/celeste/releases .
2. Get the `Celeste.pdx.zip ` file.
3. Sideload it to your Playdate device. (You can refer to the official [Sideloading Playdate games](https://help.play.date/games/sideloading/) documentation.)

If you don’t own a Playdate, you can play in the [Playdate Simulator](https://help.play.date/manual/simulator/) on Windows, macOS or Linux. Download and install the [Playdate SDK](https://play.date/dev/).
If you don’t own a Playdate, you can play in the [Playdate Simulator](https://help.play.date/manual/simulator/) on Windows, macOS or Linux. Download and install the [Playdate SDK](https://play.date/dev/). Place the `.pdx` file in the `PlaydateSDK/Disk/Games/` folder.

### Compilation

The `.pdx` available for download has been compiled on macOS. If you play on another system, you’ll need to recompile the game. You can do this by cloning this repository and executing the following command from the root of the project.

```sh
pdc ./Source Celeste.pdx
```

## Changes

Expand All @@ -32,7 +40,7 @@ Playdate is a registered trademark of [Panic](https://panic.com/).

The Playdate port was done by [Rémi Parmentier](https://github.com/HTeuMeuLeu).

Thanks to [Alex Larioza](https://github.com/SHiLLySiT) for help and tips on performance optimizations.
Thanks to [Alex Larioza](https://github.com/SHiLLySiT) for help and tips on performance optimizations. And thanks to the wonderful people on Discord (_orkn, Grhmhome, Drew-Lo, Gamma, Kiwi, Tristianski, jeffamphetamines, PizzaDev, Kucromy, Guv_Bubbs, NickSr, Andrew, DoctorMikeReddy, natch, rasith, Braillynn, fnc12_) for their feedback.

## License

Expand Down

0 comments on commit e6a3f70

Please sign in to comment.