---

DELETE THIS INSTRUCTIONS AND ADD AN INTRODUCTION ABOUT YOUR PROJECT

---

eYY-3yp-project-template

This is a sample repository you can use for your Embedded Systems project. Once you followed these instructions, remove the text and add a brief introduction to here.

Enable GitHub Pages

You can put the things to be shown in GitHub pages into the docs/ folder. Both html and md file formats are supported. You need to go to settings and enable GitHub pages and select main branch and docs folder from the dropdowns, as shown in the below image.

Special Configurations

These projects will be automatically added into https://projects.ce.pdn.ac.lk. If you like to show more details about your project on this site, you can fill the parameters in the file, /docs/index.json

{
  "title": "This is the title of the project",
  "team": [
    {
      "name": "Team Member Name 1",
      "email": "[email protected]",
      "eNumber": "E/yy/xxx"
    },
    {
      "name": "Team Member Name 2",
      "email": "[email protected]",
      "eNumber": "E/yy/xxx"
    },
    {
      "name": "Team Member Name 3",
      "email": "[email protected]",
      "eNumber": "E/yy/xxx"
    }
  ],
  "supervisors": [
    {
      "name": "Dr. Supervisor 1",
      "email": "[email protected]"
    },
    {
      "name": "Supervisor 2",
      "email": "[email protected]"
    }
  ],
  "tags": ["Web", "Embedded Systems"]
}

Once you filled this index.json file, please verify the syntax is correct. (You can use this tool).

Page Theme

A custom theme integrated with this GitHub Page, which is based on github.com/cepdnaclk/eYY-project-theme. If you like to remove this default theme, you can remove the file, docs/_config.yml and use HTML based website.