Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
morr0ne committed Mar 8, 2024
1 parent ecdc980 commit d15455e
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,27 @@
# Cake - The Portal ending screen in your browser

A recreation of the Portal ending screen made using web tecnologies
A tribute to one of my favorite games of all time: Portal.

Built on top of web technologies (HTML, JS, and CSS) using Astro as the
underlying framework.

The aim is to build a version that is 100% accurate, or as close to that as
reasonably possible. This is achieved by carefully analyzing the assets of the
original game instead of relying on guesswork like other similar projects.

## Running locally

To run the project locally first ensure you have nodejs version >=18.14.1 with
corepack enabled.

Then after cloning the repository run the following commands:

```bash
pnpm install
pnpm run dev
```

You can then access the site by visiting http://localhost:4321 in your browser.

## License

Expand Down

0 comments on commit d15455e

Please sign in to comment.