diff --git a/README.md b/README.md index 62848ea..3e3fbe1 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,84 @@ ### Bouncing Balls WebSite -This is a bouncing balls website. It uses HTML, Javascript and Canvas API to generate a Website with bouncing balls animation. +This is a **Website** which uses *HTML*, *CSS*, *Javascript* and *Canvas API* to generate a **Ball Bouncing Frame Animation**. --- -### Requires -###### Node.js -``` -https://nodejs.org/en/download/package-manager/ -``` +### Dependences +This is **dependences** to run the program: + +| Name | Download Link | +|------------|------------------------------------------------| +| NodeJS | https://nodejs.org/en/download/package-manager | + +### Installing + +#### NodeJS + 1. Open the **terminal** + + - Windows + ``` + Windows + R : "cmd" or "powershell" + ``` + + - Linux + ``` + Ctrl + Alt + T + ``` + + 2. Insert the following command + + ``` + cd + ``` + + 3. Then + ``` + npm init -y + ``` --- ### How to run -1. Download **Index.html**, **Style.css** and **Script.js** +1. Download *Index.html*, *Style.css* and *Script.js* 2. Create a folder called **bouncing-balls** + - In the folder location, insert the following command + ``` + mkdir bouncing-balls + ``` -3. Move **Index.html**, **Style.css** and **Script.js** files to **bouncing-balls** folder +3. Move *Index.html*, *Style.css* and *Script.js* files to *bouncing-balls* folder + - In the **terminal** + ``` + move + ``` 4. Open the **bouncing-balls** folder + - In the **terminal** + ``` + cd + ``` + +5. Copy the ** and paste in browser + ``` + file:\\\ + ``` + + - PS.: Remove the Quotation marks from ** + +7. Wait until the site load completelly + +##### OR +4. Open the **bouncing-balls** folder in **File Explorer** -5. Click with the *Right Mouse Button* on **Index.html** file +5. Click with the *Right Mouse Button* on *Index.html* file -6. Select the *Open with* option and select your *Browser* +6. Select the *Open with* option and select a **Browser** -7. Wait for the site to load completelly and test it +7. Wait until the site load completelly -#### or acess it with the following URL: +#### OR Acess it with the following URL: ``` https://jonaxplanta.github.io/BouncingBalls/