Skip to content

Commit 94aecb3

Browse files
committed
docs: edited readme; added screenshots of different screen size displays
1 parent 80fdddd commit 94aecb3

File tree

4 files changed

+36
-23
lines changed

4 files changed

+36
-23
lines changed

README.md

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Second Milestone Project for the Web Development course offered by Code Institut
1818

1919
**Technologies Used:** HTML5, CSS3, JavaScript.
2020

21+
**Testing Technologies Used:** Jest.
22+
2123
## UX
2224

2325
### Project Goals
@@ -44,10 +46,16 @@ I want:
4446

4547
### Design Choices
4648

47-
To be added when the site is properly coded.
48-
4949
#### Interface
50-
I intend to use a simple webpage consisting of 4 game buttons of different colours and a start button, as well as a high score display and longest pattern display.
50+
*Pattern* is built as a simple one-page website consisting of 4 game buttons of different colours and a start button, as well as a high score display and longest pattern display.
51+
52+
![Pattern home page.](docs/pattern-page-display.png)
53+
54+
The site shifts to accommodate several screen sizes while keeping the same basic layout.
55+
56+
![Tablet screen, 768px wide.](docs/pattern-tablet-display.png)
57+
58+
![Mobile screen, 425px wide.](docs/pattern-mobile-l-display.png)
5159

5260
#### Colours
5361
![Palette](docs/pattern-palette.png)
@@ -70,41 +78,42 @@ I have used MS Paint to sketch out a basic wireframe for the site:
7078

7179
## Testing
7280

81+
The site has been tested extensively to ensure the best user experience across multiple screen sizes.
82+
7383
- [W3C CSS Validation](https://jigsaw.w3.org/css-validator/#validate_by_input)
7484
- [W3C Markup Validation](https://validator.w3.org/#validate_by_input)
7585

7686
The developer used **W3C CSS Validation Service** and **W3C Markup Validation Service** to check the validity of the website code.
7787

78-
<!-- The site has been tested extensively to ensure the best user experience across multiple screen sizes.
79-
8088
### Testing Process
8189

82-
In order to make sure the site renders acceptably across several screen sizes, I made liberal use of the DevTools offered by Google Chrome (or in my case, the Opera GX browser that closely mimics Chrome) as well as testing load times of each page, mobile and desktop, with the Lighthouse Chrome extension.
83-
84-
![Testing main page desktop version.](assets/images/readme/lighthouse_test_main_desktop.png)
85-
86-
![Testing main page mobile version.](assets/images/readme/lighthouse_test_main_mobile.png)
90+
In order to make sure the site renders acceptably across several screen sizes, I made liberal use of the DevTools offered by Google Chrome.
8791

8892
### User Stories Testing
8993

9094
As a user of the site, I want:
9195
- an intuitive game interface.
92-
-
93-
-
94-
-
96+
- Ensured that buttons respond to being clicked.
97+
- Ensured that buttons can only be pressed when the pattern isn't being displayed.
9598
- a game interface that's easy to look at.
96-
-
97-
-
98-
-
99+
- Subjective, but I believe the simple multicoloured buttons set against a white background is easy to look at and keeps player attention on the game itself.
99100
- a game whose rules are easy to understand.
100-
-
101-
-
101+
- The game simply requires that the player click the buttons in the order of the pattern they are shown.
102102
- a clear indication of when I have made a mistake.
103-
-
104-
-
105-
-
103+
- Tested that game stops when player makes a mistake.
104+
- Tested that the player is alerted when a mistake has been made and the game is reset properly.
106105
- a way to track my longest run.
107-
- -->
106+
- Tested that
107+
108+
<!--
109+
110+
(or in my case, the Opera GX browser that closely mimics Chrome) as well as testing load times of each page, mobile and desktop, with the Lighthouse Chrome extension.
111+
112+
![Testing main page desktop version.](assets/images/readme/lighthouse_test_main_desktop.png)
113+
114+
![Testing main page mobile version.](assets/images/readme/lighthouse_test_main_mobile.png)
115+
116+
-->
108117

109118
### Bugfixes
110119
- **Problem:** There was a mass of unneeded whitespace at the bottom of the page.
@@ -163,4 +172,8 @@ Then follow these steps:
163172

164173
### Code
165174

166-
Code not written by me and not covered below is attributed to proper sources in comments within the code. All other code is written by me.
175+
Code not written by me and not covered below is attributed to proper sources in comments within the code. All other code is written by me.
176+
177+
#### Guidance and Inspiration
178+
179+
[Simen Daehlin](https://github.com/Eventyret "Simen Daehlin")

docs/pattern-mobile-l-display.png

30 KB
Loading

docs/pattern-page-display.png

43.4 KB
Loading

docs/pattern-tablet-display.png

33.6 KB
Loading

0 commit comments

Comments
 (0)