Giter Club home page Giter Club logo

newton's Introduction

Newton - NG Curriculum

The complete structure of a course is explained here. This will help you create a new course in this repo :) You can also browse through other courses (every directory is a course) to understand more about the structure.

Structure of a course on SARAL

Every course has a seperate directory within this repo. Like the Python course has a python directory, html has a html directory and so on.

index.md?

This is the single most important file where you store the list of the contents in the course. Looking at following for an example:

Course Structure

- index.md
- info.md
	

index.md

- introduction-to-programming.md
- hello-world.md
- introduction-to-loops
	- understanding-while-loops.md
	- understanding-break-conditions.md
- exercise-4.md
- exercise-5.md

These files have to exist in the parent directory. introduction-to-loops.md is a folder, and understanding-whilte-loops.md etc. are files that are to exist in the directory.

The Every course directory has one main files which name is, info.md

info.md

This has some meta information of the course which is used when putting the course in the database. Here is a sample file

```ngMeta
name: Basics of Programming using Python
type: python
days_to_complete: 45
short_description: We will learn the basics of programming using this course.
logo: http://google.com/logo.png
```

All the meta information about a course needs to be nested within a ngMeta tag in the markdown file.

Order of Exercises

The files can be named anything we want as curriculum developers. The order of files (the order in screenshot) is decided by the order written in index.md file.

The structure of index.md will be like this:

exercise-1.md
exercise-2.md
exercise-3/exercise-3.md
	- another-child-of-exercie-3.md
	- yet-another-child.md

Notice how exercise-3 directory has three files inside while the tree structure in the screenshot only has 2 children under it. This is because here in index.md the file exercise-3.md is marked as a parent exercise while the other two are marked as child. Notice how they are intended in the above snippet. When the learner/student clicks on Exercise 3 on SARAL the contents of exercise-3.md will be shown.

Images in the course

The images related to a course should exist within directory of the particular course. In case there are a lot of images it can also make sense to have exercise specific directories for images to make organising this easy.

Note: Image paths in markdown file should be specific relative to the location of the file. You can use .. to for accessing the contents of the directory above the directory of the markdown file. Similarly ../.. for two directories above.

To learn Markdown visit GitHub Cheatsheet

newton's People

Contributors

abhishekgupta92 avatar anuradhadaswani avatar harjeetnavgurukul avatar annubharti avatar amarkrsinha1997 avatar vandanapandey392 avatar rashmiranganath avatar pralhad88 avatar khushboopandit avatar deeparam123 avatar ranipandit avatar rajeevatlas avatar kajal2000 avatar kajal-ahirwal avatar krishna-aaseri avatar nilam1996 avatar komalng avatar apekshahande avatar komalahire avatar amanjha18 avatar zebanavgurukul avatar pratikdeshmukh2004 avatar bhavnesh2211 avatar ssatyamchauhan avatar akhilrawat001 avatar anoop123gupta avatar deepa752 avatar vishalgaddam873 avatar yogendrajs avatar vedansh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.