Skip to content

This template will help you document your project clearly and effectively for review, collaboration, and open sharing.

Notifications You must be signed in to change notification settings

MakersAsylumIndia/IS_Project_Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“˜ Welcome to the IS Project Documentation Template!

Hey there! πŸ‘‹

This repository is your home for documenting your Innovation School Project and starting your maker portfolio.
You’ll be using the GitHub Wiki to update all your project details in a structured format.


🧠 What to Do First

Start by writing a brief introduction to your project right here in this README.md file:

πŸ”Ή What problem are you solving?
πŸ”Ή What’s your proposed solution?

Just 2–3 lines are enough. This helps others quickly understand what your project is about.

Click on the ✏️ PENCIL icon next to the README title above, and you can edit the README directly from within your browser.


πŸ›  Where to Document Everything Else

We’ve already created a standard set of Wiki pages for your project in this repository β€” you just need to update them with your project information.

Each section is ready with headings like:

  • Project Title
  • Problem Statement
  • Bill of Materials (BOM)
  • Solution Overview
  • SDG Goals Associated
  • Circuit & CAD Files
  • Media Gallery
  • License

Please do not delete the headings β€” just replace the placeholder content under each.


πŸ“š How to Edit the GitHub Wiki Pages

Follow these official GitHub help guides to learn how to edit your Wiki pages:

πŸ”— How to Add or Edit Wiki Pages
πŸ”— How to Format and Save Content in Wikis


πŸ“Έ Visual Guide (Optional)

If you’re unsure where the Wiki tab is:
πŸ“ It’s on the top-right area of the repository (next to Code, Issues, Pull Requests).

You’ll find your project listed there. Click on it, then click β€œEdit” to begin updating.


🀝 Need Help?

If you're confused at any step:

  • Ask your mentor or coordinator
  • Or drop a message in our Discord/WhatsApp support group

Let’s build something awesome! πŸš€

License

Licenses

Open Source Licenses Facts

Hardware

CERN Open Hardware License Version 2 - Strongly Reciprocal (CERN-OHL-S-2.0).

Software

MIT open source license.

Documentation:

Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License.


πŸ“¬ Contact/Team

List team members and contact emails or GitHub profiles.


About

This template will help you document your project clearly and effectively for review, collaboration, and open sharing.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •