Skip to content
Permalink
738d54b1c4
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/tutorial.md

Go to file
 
 
Cannot retrieve contributors at this time
Tutorial Requirements Installation Building our First Document Modifying our Document Creating Marking Feedback
80 lines (51 sloc) 1.6 KB
Raw Blame

Tutorial

A Quick Start Guide for using the tool. This assumes a generic Linux / Mac / Windows system.

I will put together a specific version for a University Windows image, when I work out the Gotchas.

Requirements

All the requirements should be in the standard uni image.

  • Web Browser
  • Text Editor
  • Python (3.x preferred)

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

Installation

Get a copy of the source code from the Github Repo It doesn't matter if you clone the repository or get the zip file.

Once you have the code navigate to its location using the command line.

cd <path>/<to>/<source>
### OPTIONAL: Using a virtaul envionment

Virtual environments (venv) give us a way of sandboxing python software we install. It means that they are not installed in the global path. Personally, as a developer, I prefer this as it means I dont get caught out by dependencies or clutter up my Python namespace with cruft.

We can create a venv using

python -m venv env

Each time we want to use the code we need to access enter the virtual environment. We can do this in Linux / mac with

$source env/bin/activate

or Windows

C:\> env\Scripts\activate.bat

We can now install the program using the setup script.

$ python setup.py install

Building our First Document

cd examples
$ runDMC CourseworkBrief.md -t coursework/CourseworkBrief.jinja2

Modifying our Document

Creating Marking Feedback