Skip to content
Permalink
13d63c849f
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

reMarkAble/docs/index.md

Go to file
 
 
Cannot retrieve contributors at this time
reMarkAble Markdown Marking Install Requirements Documentation Improvements and Contributing Bugs or Undocumented Features? Contributing
62 lines (35 sloc) 1.46 KB
Raw Blame

reMarkAble Markdown Marking

This project allows us to generate documents such as Coursework Briefs, or Feedback using markdown. I find it a much nicer way of working, and the generated docs should be more consistent for the students.

You can read my rationale for developing it here

There is currently a generic feedback template, and a template based on the EEC coursework brief document.

!!! note

The Generic coursework Brief is a WIP.  While the method to generate will
stay the same, the look and feel will certainly change (when I get
some UX time and feedback)

Install Requirements

All the requirements should be in the standard uni image.

  • Web Browser
  • Text Editor (Notepad, Emacs or VS Code)
  • Python (3.x)

All the code uses native python packages, so there should be no need to install any other software.

Documentation

Improvements and Contributing

Bugs or Undocumented Features?

Are to be expected, been cobbling this together in my weekends.

There is an Issue tracker please use it.

Contributing

If you have any:

  • Ideas for improvement / Feature Requests
  • New Templates
  • Code contributions

You are welcome to contribute to the project. The more people who use it the better.

Either get in touch, submit and issue, or a pull request with your changes.