Skip to content

Commit

Permalink
Change readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bryukh committed Jul 17, 2013
1 parent a84a3d2 commit de2ebf1
Showing 1 changed file with 2 additions and 119 deletions.
121 changes: 2 additions & 119 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,122 +1,5 @@
checkio-task-template
checkio-task-binary-morse
=====================

This is the base CheckiO template for user generated tasks.
It have fixed the folder structure so please be careful with
your file and naming conventions.


Tasks examples
--------------


Files definition
----------------

Below you can read an explanation for role of each folder and file inside the project.

### Info folder

This folder contain info about task's mission.

#### task_description.html

This file is a description for your task.
Here, you should explain the goal for the task.
When writing this file, you must use proper HTML syntax for the description to
be readable on the site as it will be inserted on the task page as a block.

##### Task's text
Next, you must write the main description of the task.
You can insert some images for explanation (see below for
information about images) and you can use html tags as 
em strong or pre to display formulas or example code.
Each paragraph or div element can have the class
"for_editor_only" or "for_info_only".

**"for\_editor\_only"** – means that the element will only show in the editor mode.

**"for\_info\_only"** – will only show up in the main task description.

##### Input and Output
This is short description of input and output data.

##### Example
This section gives some examples for the task.
You can use the pre tag with class "brush: python" for syntax highlighting.

##### Images
You can paste your images inside task.
The files for these must be placed inside the illustrations folder.
The link defined as src="{{ MEDIA_URL }}/*image-name.png*"
Illustrations should be created with specified colors from colors guide. (*color.pdf* or *example.png*))

##### Icons
Icons for task placed inside logo folder.
Icons are created as pair: 
**disabled.svg** for unsolved tasks and **enabled.svg** for solved tasks.
In the task runner you can see the both icons with click to it.
Icons should be created with specified icons' colors from colors
guide (*color.pdf*).
Icons must have size 128x128 and placed inside grey color with size 116x116 at center with border radius 10.
Use the given template.

#### story.html
This is some funny story about task, it does not need to
explain task's goal. A paragraph of div with the story
class does not show in the editor's task description.


#### task.json
This is the task config with some useful info.

*global section*

**task_name** -- The name of the task.

*editor section*

**tryit\_results\_height** -- the height of tryit results. If you dont want to use tryit, then set it to 1.

**tryit\_results\_width** -- the width of tryit results. If you dont want to use tryit, then set it to 1.

**animation\_panel\_width** -- the width of animation's panel.

**console\_height** -- the height of bottom console. As usual, set it as tryit\_results\_height + 30

### Verification Folder

This folder contains files with tests.
Each set of test must be a python file with name test\_*category*.py.
Each file contain variable name TESTS with a list of dicts using for testing with referee file.
The base referee use "input" as input data, "answer" as right answer, "explanation" as additional info if you use some animation.



#### initial_code/interpretator

Here is the code which users will see as a starting template for interpretator

### Editor folder

#### animation.js

This file describe an animation for tests explanation or tryit.
It's **not necessary** to change it.

Further description of this will be added later.

#### animation.css

This file describe styles for tests explanation or tryit.
It's **not necessary** to change it.

Further description of this will be added later.

#### template.html

This file describe layout and structure for tests explanation or tryit.
It's **not necessary** to change it.

Further description of this will be added later.
This is the task for Checkio "Binary Morse"

0 comments on commit de2ebf1

Please sign in to comment.