README.md from nus-mtp/sashimi-note

README.md
Summary

Maintainability

Test Coverage

Issues
<p align="center">
  <a href="https://sashimi-note.herokuapp.com">
    <img width="80%" src="https://rawgit.com/wiki/nus-mtp/lecture-note-2.0/media/Misc/sashimi-note-logo-github.svg">
  </a>
</p>

<p align="center">
  <a href="https://travis-ci.org/nus-mtp/sashimi-note">
    <img src="https://travis-ci.org/nus-mtp/sashimi-note.svg?branch=master" title="Build Status of master branch">
  </a>
  <a href="https://codeclimate.com/github/nus-mtp/sashimi-note/coverage">
    <img src="https://codeclimate.com/github/nus-mtp/sashimi-note/badges/coverage.svg" title="[Test Coverage">
  </a>
  <a href="https://codeclimate.com/github/nus-mtp/sashimi-note">
    <img src="https://codeclimate.com/github/nus-mtp/sashimi-note/badges/gpa.svg" title="Code Climate">
  </a>
</p>

<img height="30">




PowerPoint slides are often used to deliver lecture content to the students. The same printable PowerPoint slides are often provided to the students in a PDF format. This causes several problems. In most cases, all interactive material (*such as video, animation, things that the lecturer has said*) are removed or disabled in this format (*pdf*). Printed PowerPoint may not be the best way to represent information. It waste space and may not have an effective organisation of information.


### Our goal:
To provide a **flexible** and **extensible** document viewing and editing platform that can be used in class (during lecture) and out of class (revision) to allow lecturers to provide a more effective and comfortable learning experience to students, so that students can learn more effectively.
[Read more](https://github.com/nus-mtp/sashimi-note/wiki/1.-Introduction)

<img height="60">

## Development

### Step 1: Install
```
yarn
```

### Step 2: Develop
```
cd sashimi-webapp
yarn run dev
```

<br>

Click [here](https://github.com/nus-mtp/sashimi-note/wiki/5.-Developer-Guide) for the full developer guide

<img height="60">

## Other information
1. Project website
  [nus-mtp.github.io/sashimi-note](https://nus-mtp.github.io/sashimi-note)
2. Sashimi Note Webapp
  [sashimi-note.herokuapp.com](https://sashimi-note.herokuapp.com)
3. Video demo
  [youtu.be/O3wBi7Hid7kay](https://youtu.be/O3wBi7Hid7kay)
4. Changelog
  [nus-mtp/sashimi-note/releases](https://github.com/nus-mtp/sashimi-note/releases)