Jelajahi Sumber

update readme files

lairaalmas 1 tahun lalu
induk
melakukan
1c245a6353
2 mengubah file dengan 12 tambahan dan 12 penghapusan
  1. 4 4
      README.md
  2. 8 8
      src/php/README.md

+ 4 - 4
README.md

@@ -14,9 +14,9 @@ Follow the description below based on in which platform you want to run iFractio
 
 #### 1) on a server
 
-* Extract the content of **Ifraction-web.zip** inside the server directory
+* Extract the content of `Ifraction-web.zip` inside the server directory
 
-* Check that the variable **moodle** is set to **false** inside **/js/globals/global_control.js**
+* Check that the variable `moodle` is set to **false** inside `src/js/globals/global_control.js`
 
 * It can now be accessed through the **browser** (e.g http://localhost/Ifractions-web)
 
@@ -24,7 +24,7 @@ Follow the description below based on in which platform you want to run iFractio
 
   * you'll need to have **PHP** and **MySQL** installed on the machine
 
-  * follow the steps on **/php/README.md** to setup the database and variables
+  * follow the steps on `src/php/README.md` to setup the database and variables
 
 * Otherwise you're good to go.
 
@@ -34,7 +34,7 @@ iFractions is one of the iLM (Interactive Learning Modules) provided by the iAss
 
 * To download and setup iAssign access: http://200.144.254.107/git/LInE/iassign
 
-* Be sure to check that the variable **moodle** is set to **true** inside **/js/globals/global_control.js**
+* Be sure to check that the variable **moodle** is set to **true** inside `src/js/globals/global_control.js`
 
 * With iAssign installed, as a Moodle professor on you'll be able to:
   

+ 8 - 8
src/php/README.md

@@ -9,8 +9,8 @@ First you'll need a **MySQL** database installed on the server (more info in htt
 Now, in order for iFractions to successfully establish a connection to the database you must:
 
 1. create and set up the database for the game.
-2. update `/php/save.php` 
-3. update `/js/globals/globals_functions.js`
+2. update `src/php/save.php` 
+3. update `src/js/globals/globals_functions.js`
 
 ## 1) Creating the database for iFractions
 
@@ -41,7 +41,7 @@ Note that each column has the prefix `line_`.
 
 ## 2) `save.php`
 
-You have to set values for the following variables in `/php/save.php` to match the database's:
+You have to set values for the following variables in `src/php/save.php` to match the database's:
 
 	$servername = "localhost"; 	// INSERT MySQL server
 	$username = "your_db_username";	// INSERT MySQL user name
@@ -51,7 +51,7 @@ You have to set values for the following variables in `/php/save.php` to match t
 
 ## 3) `globals_functions.js`
 
-Inside `/js/globals/globals_functions.js` there's a global function called `sendToDatabase()`. When the player's information is collected after each game, the game file sends it as a parameter to `sendToDatabase()`. It makes an asynchronous call to `/php/save.php`, that executes the connection to the database.
+Inside `src/js/globals/globals_functions.js` there's a global function called `sendToDatabase()`. When the player's information is collected after each game, the game file sends it as a parameter to `sendToDatabase()`. It makes an asynchronous call to `src/php/save.php`, that executes the connection to the database.
 
 	const data = 'line_ip='// INSERT the IP of the machine where the MySQL was set up
 		+ '&line_name=' + // player's name
@@ -62,11 +62,11 @@ Inside `/js/globals/globals_functions.js` there's a global function called `send
 # Where do we use the database in the code?
 
 There is a function `postScore()` in every game file:
-* `/js/games/squareOne.js`
-* `/js/games/squareTwo.js`
-* `/js/games/circleOne.js`
+* `src/js/games/squareOne.js`
+* `src/js/games/squareTwo.js`
+* `src/js/games/circleOne.js`
 
-After each level is completed (with the player's answer being correct or not), before going back to the level map, the function `postScore()`, is called. It joins all the player's progress information into a string (as can be seen below), that is sent as a parameter to `sendToDatabase()`, from `/js/globals/globals_functions.js`, that sends it to the database.
+After each level is completed (with the player's answer being correct or not), before going back to the level map, the function `postScore()`, is called. It joins all the player's progress information into a string (as can be seen below), that is sent as a parameter to `sendToDatabase()`, from `src/js/globals/globals_functions.js`, that sends it to the database.
 
 	const data = '&line_game=' + // collect game shape
 	+ '&line_mode=' + // collect game mode type