Skip to content
This repository has been archived by the owner on Nov 13, 2023. It is now read-only.

Commit

Permalink
Merge branch documentation/readme-update (#101)
Browse files Browse the repository at this point in the history
* Update README.md

- Refactor instructions to a table
- Refactor supported browsers to a table
- Cleanup

* Update README.md

Link license file

* Update README.md

Refactor "Known Bugs" section
  • Loading branch information
Kitt3120 committed Jun 19, 2023
1 parent 19f6123 commit 1675794
Showing 1 changed file with 29 additions and 20 deletions.
49 changes: 29 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,22 +41,26 @@ A web-based 2D clone of Valve's famous puzzle game, Portal

You can play the game right in your browser on https://portal.schweren.dev

## Instrucitons

- arrow left | a = run left
- arrow right | d = run right
- arrow up | w | space = jump

- left click on wall = purple portal
- right click on wall = green portal

- b = dev view
## Instructions

| Key | Action |
| --- | ------ |
| Arrow Left | Run left |
| A | Run left |
| Arrow Right | Run right |
| D | Run right |
| Arrow Up | Jump |
| W | Jump |
| Space | Jump |
| Left Click | Shoot purple portal |
| Right Click | Shoot green portal |
| B | Debug view (for nerds) |

## Installation

### Current Version

Version = 1.0.1 (creation date = 19.06.2023)
Version = 0.1.0 (creation date = 19.06.2023)

### Docker

Expand All @@ -70,9 +74,18 @@ Version = 1.0.1 (creation date = 19.06.2023)
3. Drop files into a web server like nginx or apache
4. Connect to your web server

### Browser compatibility

| Browser | Status |
| ------- | ------ |
| Chrome ||
| Firefox ||
| Safari ||
| Other browser | Will probably also work |

## Credits & Licenses of assets

- Own License: Apache License view LICENSE file
- Sour code license: Apache License ([view LICENSE file](https://github.com/Torben-Tom/Portal/blob/main/LICENSE))

- Player, Buttons, Background: https://github.com/Chinnami
- Portals: https://www.patreon.com/posts/27430241
Expand All @@ -81,20 +94,16 @@ Version = 1.0.1 (creation date = 19.06.2023)
- favicon: https://www.favicon.cc/?action=icon&file_id=359150
- Music: https://www.fesliyanstudios.com/policy

## Development parts & Authors
## Development & Authors

Project Board: https://github.com/orgs/Torben-Tom/projects/1
Project Board: [View project board](https://github.com/orgs/Torben-Tom/projects/1)

- Engine: mostly Torben Schweren
- Game: mostly Tom Moritz
- Pipeline: Torben Schweren

The exact partial contributions can be found in the "Done" column of the Broject Board.

- known Bugs: view the "Backlog" column of the Project Board

## Browser compatibility
## Known Bugs

- Chrome
- FireFox
- Safari
View the "Backlog" column of the [Project Board](https://github.com/orgs/Torben-Tom/projects/1)

0 comments on commit 1675794

Please sign in to comment.