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

Commit 1675794

Browse files
authored
Merge branch documentation/readme-update (#101)
* 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
1 parent 19f6123 commit 1675794

File tree

1 file changed

+29
-20
lines changed

1 file changed

+29
-20
lines changed

README.md

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,26 @@ A web-based 2D clone of Valve's famous puzzle game, Portal
4141

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

44-
## Instrucitons
45-
46-
- arrow left | a = run left
47-
- arrow right | d = run right
48-
- arrow up | w | space = jump
49-
50-
- left click on wall = purple portal
51-
- right click on wall = green portal
52-
53-
- b = dev view
44+
## Instructions
45+
46+
| Key | Action |
47+
| --- | ------ |
48+
| Arrow Left | Run left |
49+
| A | Run left |
50+
| Arrow Right | Run right |
51+
| D | Run right |
52+
| Arrow Up | Jump |
53+
| W | Jump |
54+
| Space | Jump |
55+
| Left Click | Shoot purple portal |
56+
| Right Click | Shoot green portal |
57+
| B | Debug view (for nerds) |
5458

5559
## Installation
5660

5761
### Current Version
5862

59-
Version = 1.0.1 (creation date = 19.06.2023)
63+
Version = 0.1.0 (creation date = 19.06.2023)
6064

6165
### Docker
6266

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

77+
### Browser compatibility
78+
79+
| Browser | Status |
80+
| ------- | ------ |
81+
| Chrome ||
82+
| Firefox ||
83+
| Safari ||
84+
| Other browser | Will probably also work |
85+
7386
## Credits & Licenses of assets
7487

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

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

84-
## Development parts & Authors
97+
## Development & Authors
8598

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

88101
- Engine: mostly Torben Schweren
89102
- Game: mostly Tom Moritz
90103
- Pipeline: Torben Schweren
91104

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

94-
- known Bugs: view the "Backlog" column of the Project Board
95-
96-
## Browser compatibility
107+
## Known Bugs
97108

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

0 commit comments

Comments
 (0)