Browse Source

README.textile -> README.md

master
Xavier B. 1 year ago
parent
commit
4efa2f8891
2 changed files with 55 additions and 58 deletions
  1. 55
    0
      README.md
  2. 0
    58
      README.textile

+ 55
- 0
README.md View File

@@ -0,0 +1,55 @@
# my-drag-and-drop-khan-academy

## Name

For brevity, just say *mdadak* (My Drag And Drop Academy Khan). And don't ask me how you have to pronunce it: how you want ;-).

Originally the name of the repository had a typo in the name: it's "Kahn Academy". But when I create the repository, I don't remember exactly the name and... I will not change that. It serves for see we are different of Khan Academy ;-) Now it's corrected.

## Intentions

* Like Khan Academy but more more more simple and always with drag and drop things.
* Not compete with Khan Academy. Complement it.
* The intention is to have **minimal** and **portable** framework for writting, essentially, drag and drop questions and answers quizzes (eg. identifying the parts of the human cell)

## State

The state is rudimentary, but functional.

## Development language

My native language is catalan. So catalan is the development language of this project. This means that commits, notes and variables in source code are, mostly, in catalan. Minor documents could be also in cataln. But I hope the code is good enough to anyone could understand, modify and adapt to his/her language and context.

## License

The software is licensed under the ["MIT License"](http://en.wikipedia.org/wiki/MIT_License) and the content on this site, except where otherwise noted, is licensed under a ["Creative Commons Attribution 4.0 License"](http://creativecommons.org/licenses/by/3.0/). For more information see `LICENSE.md` file.

## Structure of the project

There are two sets of exercises, that I maintain in two separate git branches:

* "master branch": contains *all* exercises, good or bad, revised or not.
* "gh-pages branch": there are only the *worthy* and revised exercises. The exercises of "gh-pages" *were* accessible via web [here](http://somenxavier.github.com/my-drag-and-drop-kahn-academy/) (not now). So the set of exercises of gh-pages is a subset of the set of exersises of master branch formed by good enough ones.

## Directories

* In "./stylesheets" there are CSS files for general presentation of pages. It's mainly used in gh-pages branch.
* In "./docs" there are docs about project: greetings (in catalan), history (in catalan), Instructions for adapt and modify the exercises (for fit to your needs), etc.
* In "./exers" there are the exercises. Each exercise has specific CSS and javascript within. There is also one example exercise (template exercise).

### Pattern of files

For convention, I group the exercises by units or themes. Each unit is a directory which has the name `{number}-{name of the unit}` (example `01-cell` corresponds to the unit 01 Cell). The number has no meaning but cronologically order.

In each unit directory, I name the exercise files by this way: `{unit name}-{number of exercise}-{abreviation of the language of the exercise}.html`. The abreviation of the language belongs to [ISO 639-1 code](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).


## History and greetings

If you are interested in the history of the project, you can read [here](https://github.com/somenxavier/my-drag-and-drop-kahn-academy/blob/master/docs/Història.md) (in catalan). By the other hand, there is a [file](https://github.com/somenxavier/my-drag-and-drop-kahn-academy/blob/master/docs/Agraïments.md) of greetings (also in catalan).

## Participation

If you want to submit some exercises to me, please do it. I will analyse, and, if I like those, I will be glad to add to my project. Otherwise, you could fork my project.

You can also warn me about typos or grammatical errors in english. As I noted above, it's not my native language.

+ 0
- 58
README.textile View File

@@ -1,58 +0,0 @@
h1. my-drag-and-drop-khan-academy

h2. Name

For brevity, just say <em>mdadak</em> (My Drag And Drop Academy Khan; yes, I know it's Khan Academy but it sounds better ;). And don't ask me how you have to pronunce it: how you want ;-).

Finally, yes, I'm know I have a typo in the name: it's "Kahn Academy", not "Kahn Academy", but when I create the repository, I don't remember exactly the name and... I will not change that. It serves for see we are different of Khan Academy ;-)

h2. Intentions

* Like Khan Academy but more more more simple and always with drag and drop things.
* Not compete with Khan Academy. Complement it.
* The intention is to have **minimal** and **portable** framework for writting, essentially, drag and drop questions and answers quizzes (eg. identifying the parts of the human cell)

h2. State

The state is rudimentary, but functional.

h2. Development language

My native language is catalan. So catalan is the development language of this project. This means that commits, notes and variables in source code are, mostly, in catalan. Minor documents could be also in cataln. But I hope the code is good enough to anyone could understand, modify and adapt to his/her language and context.

h2. License

The software is licensed under the "MIT License":http://en.wikipedia.org/wiki/MIT_License and the content on this site, except where otherwise noted, is licensed under a "Creative Commons Attribution 3.0 License":http://creativecommons.org/licenses/by/3.0/. For more information see LICENSE.textile "file":https://github.com/somenxavier/my-drag-and-drop-kahn-academy/blob/master/LICENSE.textile.

h2. Structure of the project

There are two sets of exercises, that I maintain in two separate git branches:

* "master branch":https://github.com/somenxavier/my-drag-and-drop-kahn-academy/tree/master: contains <em>all</em> exercises, good or bad, revised or not.
* "gh-pages branch":https://github.com/somenxavier/my-drag-and-drop-kahn-academy/tree/gh-pages: there are only the <em>worthy</em> and revised exercises. The exercises of gh-pages are accessible via web "here":http://somenxavier.github.com/my-drag-and-drop-kahn-academy/. So the set of exercises of gh-pages is a subset of the set of exersises of master branch formed by good enough ones.

h3. Directories

* In "./stylesheets":https://github.com/somenxavier/my-drag-and-drop-kahn-academy/tree/master/stylesheets there are CSS files for general presentation of pages. It's mainly used in gh-pages branch.
* In "./docs":https://github.com/somenxavier/my-drag-and-drop-kahn-academy/tree/master/docs there are docs about project: greetings (in catalan), history (in catalan), Instructions for adapt and modify the exercises (for fit to your needs), etc.
* In "./exers":https://github.com/somenxavier/my-drag-and-drop-kahn-academy/tree/master/exers there are the exercises. Each exercise has specific CSS and javascript within. There is also one example exercise (template exercise).

h3. Pattern of files

For convention, I group the exercises by units or themes. Each unit is a directory which has the name {number}-{name of the unit} (example 01-cell corresponds to the unit 01 Cell). The number has no meaning but cronologically order.

In each unit directory, I name the exercise files by this way: {unit name}-{number of exercise}-{abreviation of the language of the exercise}.html. The abreviation of the language belongs to "ISO 639-1 code":http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

h2. Mirrors

There is a "mirror":http://repo.or.cz/w/my-drag-and-drop-kahn-academy.git in repo.or.cz

h2. History and greetings

If you are interested in the history of the project, you can read "here":https://github.com/somenxavier/my-drag-and-drop-kahn-academy/blob/master/docs/Història.textile (in catalan). By the other hand, there is a "file":https://github.com/somenxavier/my-drag-and-drop-kahn-academy/blob/master/docs/Agraïments.textile of greetings (also in catalan).

h2. Participation

If you want to submit some exercises to me, please do it. I will analyse, and, if I like those, I will be glad to add to my project. Otherwise, you could "fork":https://github.com/somenxavier/my-drag-and-drop-kahn-academy/fork my project.

You can also warn me about typos or grammatical errors in english. As I noted above, it's not my native language.

Loading…
Cancel
Save