Line 71: |
Line 71: |
| * [[Karma/Specifications|Karma Specifications]] (early draft) | | * [[Karma/Specifications|Karma Specifications]] (early draft) |
| * Source Code stored in http://git.sugarlabs.org/projects/karma | | * Source Code stored in http://git.sugarlabs.org/projects/karma |
− | * Version Control and repository management see [[Karma#Version_Control]] | + | * Each lesson must be in a folder named according to the schema "karma_Grade_Maths_title_WeekNo" where the week number is optional |
| + | The following are valid names |
| + | karma_3_Maths_LargestNumber_15 |
| + | karma_2_English_MatchingPuzzle |
| + | karma_6_Maths_AddingUpTo10_4 |
| + | * Version Control and repository management see the [[Karma#Version_Control|Version Control]] section of this page |
| * Unit testing is required for the karma.js library but not for individual lessons http://karma.sugarlabs.org/tests/ | | * Unit testing is required for the karma.js library but not for individual lessons http://karma.sugarlabs.org/tests/ |
| * Project Documentation kept in the Sugar Labs wiki | | * Project Documentation kept in the Sugar Labs wiki |
Line 83: |
Line 88: |
| | | |
| == Version Control == | | == Version Control == |
| + | Currently all lessons are stored in the examples/ folder of [http://git.sugarlabs.org/projects/karma/repos/mainline main karma repository] |
| + | |
| + | We plan to move all lessons into individual repositories at git.sugarlabs.org but only once we have a process to automatically build bundles. |
| + | |
| + | When we do move to individual repos we shall use the [http://git.sugarlabs.org/projects/karma_lesson karma_lesson template] for each new lesson repository |
| + | |
| + | |
| + | Here is how you can use the karma_lesson template to create a new repository from scratch |
| + | |
| + | $ git clone git://git.sugarlabs.org/karma_lesson/mainline.git |
| + | $ mkdir ../karma_3_English_3 # create a new lesson directory following our naming convention |
| + | $ cp -r * ../karma_3_English_3 |
| + | $ cd ../karma_3_English_3 |
| + | $ rm -r .git # make sure you get rid of the old git directory |
| + | $ git init |
| + | $ git add . |
| + | $ git commit -a -m "first commit" |
| + | |
| + | Now go to the http://git.sugarlabs.org/projects/new, make sure you are logged in |
| + | Create a new project, use the same name as you did for your lesson's main folder |
| + | then, |
| + | $ git remote add origin git://... # the pubic push url |
| + | |
| + | Then on to coding your lesson ;) |
| + | |
| + | From then on |
| + | $ git push origin master # will sync your local tree w/ the server |
| + | |
| + | |
| | | |
| == Meetings == | | == Meetings == |