diff --git a/DOCS.md b/DOCS.md index 2acd868..dcc9e95 100644 --- a/DOCS.md +++ b/DOCS.md @@ -1,6 +1,52 @@ -# Emoji Minesweeper Docs +# Emoji Minesweeper Documentation + + +Welcome to the Emoji Minesweeper Docs. +Here you can find additional information for nerds! 🤓 + + +## Technologies Used + + + +[p5.js](https://p5js.org/) is a JavaScript library for creative coding, with a focus on making coding accessible and inclusive for artists, designers, educators, beginners, and anyone else. It can be used to create anything, from simple visuals to fully-fledged games like this one! + + + +[JavaScript](https://en.wikipedia.org/wiki/JavaScript) is the programming language of the web. It started as a language confined in browsers, but it is now used almost everywhere. + + + +[CSS](https://en.wikipedia.org/wiki/CSS) is a style sheet language that describes the appearance and presentation of documents and apps. + + + +[HTML](https://en.wikipedia.org/wiki/HTML) is the standard markup language for documents designed to be displayed in a web browser. It is used in every website and web app. + + + + +## Architecture + +The game logic and anything that happens inside the board is written in p5.js. The board is drawn inside a [canvas](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) element, with the help of the p5.js library. The object-oriented JavaScript paradigm is used, as each square is an instance of the class Square. The rest of the UI is written in vanilla JavaScript. Everything was written from scratch, with the whole project having only one dependency (p5.js). + + + + +## Server + +***Coming Soon:*** We are currently building our server, which will give players the ability to create an account, save stats and get ranked among other players worldwide! The repository of the server can be found [here](https://github.com/mamarmar/emoji-minesweeper-server). + + + + +## Debug Mode +In order to perform diagnostics or to study the game's internal functions, developers can access debug mode. In debug mode, the square numbers are visible on each squares, with the squares containing a mine having their number in red. Game stats are not accessible and **results are not counted** while in debug mode. + +In order to access debug mode add simply add **#debug** at the end of the game's URL. Here is a link that will take you to debug mode: [https://emojiminesweeper.com#debug](https://emojiminesweeper.com#debug) + + -Here you can find additional information about Emoji Minesweeper. ## Feature List @@ -56,6 +102,7 @@ Here you can find additional information about Emoji Minesweeper. ### Other +* Debug mode * Easy to adjust canvas for different square sizes (no hard-coded values) * Help modal * Board fade-in effect diff --git a/README.md b/README.md index aff5887..1c84f11 100644 --- a/README.md +++ b/README.md @@ -25,25 +25,18 @@ There are **three levels** (beginner, intermediate, and expert) and **five theme ## Technologies Used - -[p5.js](https://p5js.org/) is a JavaScript library for creative coding, with a focus on making coding accessible and inclusive for artists, designers, educators, beginners, and anyone else. It can be used to create anything, from simple visuals to fully-fledged games like this one! - - +      - -[JavaScript](https://en.wikipedia.org/wiki/JavaScript) is the programming language of the web. It started as a language confined in browsers, but it is now used almost everywhere. - +      - -[CSS](https://en.wikipedia.org/wiki/CSS) is a style sheet language that describes the appearance and presentation of documents and apps. - +      -[HTML](https://en.wikipedia.org/wiki/HTML) is the standard markup language for documents designed to be displayed in a web browser. It is used in every website and web app. +You can find more information about the technologies used in the [documentation](./DOCS.md#technologies-used). ### Architecture -The game logic and anything that happens inside the board is written in p5.js. The board is drawn inside a [canvas](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) element, with the help of the p5.js library. The object-oriented JavaScript paradigm is used, as each square is an instance of the class Square. The rest of the UI is written in vanilla JavaScript. Everything was written from scratch, with the whole project having only one dependency (p5.js). +Please refer to the [documentation](./DOCS.md#architecture). ### Server @@ -169,7 +162,7 @@ Clicking on the flag button 🚩 will toggle flag mode. This will enable you to ## Feature List -You can find a full(ish) feature list in the [docs file](./DOCS.md). +You can find a full(ish) feature list in the [documentation](./DOCS.md#feature-list).