Index: resources/settings/instructions/readme.md =================================================================== diff -u -r821bf955d0ba7e028bccfee7c04ca77cf80a0bd4 -r94fc1cd187816ecbf176df26f9dc5601bf379f13 --- resources/settings/instructions/readme.md (.../readme.md) (revision 821bf955d0ba7e028bccfee7c04ca77cf80a0bd4) +++ resources/settings/instructions/readme.md (.../readme.md) (revision 94fc1cd187816ecbf176df26f9dc5601bf379f13) @@ -1,20 +1,20 @@ -this folder contains the files require for the screens in the applicaiton which are instructionBased. -it has to be in the .conf folder of the home directory, for applicaiton to be able to read it when running on the device. -when running on the VM it has to be in the application project under the resources. +This folder contains the files required for the screens in the application which are instruction-based. +It has to be in the .config folder of the home directory, for application to be able to read it when running on the device. +When running on the VM, it has to be in the application project under the resources. -To meet the instruction requirement, applicaiotn needs to have a configuration file named: +To meet the instruction requirement, application needs to have a configuration file named: - instructions.conf -which is the file that have the mapping of the image:description set for each instructionBased screen. -Each instructionBased screen in the map file shall have a section with the format of: +which is the file that has the mapping of the image:description set for each instruction-based screen. +Each instruction-based screen in the map file shall have a section with the format of: - [^] -and then for each instrcution image and description a line with the format of: +and then for each instruction image and description a line with the format of: - <Description>=<image file name> -Not that the current instruction design won't allow more than one line of Description. -The naming and formats show that the instruction can not have '^' in the title or category and can not have '=' in the description. +Note that the current instruction design will not allow for more than one line of Description. +The naming and formats show that the instruction cannot have '^' in the title or category and can not have '=' in the description. Example: