Skip to content

Commit

Permalink
Updated README.md, fixes COPCSE-NTNU#27
Browse files Browse the repository at this point in the history
  • Loading branch information
ifarup authored Apr 23, 2021
1 parent 58646de commit 5c29983
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# thesis-NTNU

An NTNU thesis LaTeX document class for bachelor, master, and PhD theses. It replaces previous templates like https://github.com/COPCSE-NTNU/bachelor-thesis-NTNU and https://github.com/COPCSE-NTNU/master-theses-NTNU and provides a single template for theses at all study levels.
CoPCSE@NTNU – Community of Practice for Computer Science Education at the Norwegian University of Science and Technology – is an informal forum for lecturers in computer science and related fields across campuses and departments.

The current repository provides a LaTeX thesis template that should in principle be applicable for theses at all study levels – bachelor, master and PhD. It is closely based on the standard LaTeX report document class with added packages and customisations. The purpose of the document provided in `thesis.tex` is threefold. It should serve (i) as a description of the document class, (ii) as an example of how to use it, and (iii) as a thesis template.

The template does not have any official status, and it is not a general NTNU-level requirement to use it. It replaces previous templates like https://github.com/COPCSE-NTNU/bachelor-thesis-NTNU and https://github.com/COPCSE-NTNU/master-theses-NTNU.

## Setting up

You can use the template with [Overleaf](http://overleaf.com), and you are strongly encouraged to do so. The alternative is to install local copy of LaTeX on your laptop (not adviced, huge, difficult).

You should **fork** the COPCSE repo so that you have your own files to edit and you can always merge with the upstream changes to the template, in case the template is updated.
You should **fork** the CoPCSE repo so that you have your own files to edit and you can always merge with the upstream changes to the template, in case the template is updated.

### Setup using Overleaf

There are two ways for setting up the [**Overleaf**](http://overleaf.com) project with the template:

* Use the `.zip` copy and upload.
* Fork the the COPCSE repo so that you have your own files to edit.
* Fork the the CoPCSE repo so that you have your own files to edit.

### Building document locally

Expand Down

0 comments on commit 5c29983

Please sign in to comment.