From df36d6e407e893ed6c1dd943fddd34a6dcb867ca Mon Sep 17 00:00:00 2001 From: Borgar Lie <borgar.lie@gmail.com> Date: Sun, 22 May 2016 16:29:36 +0200 Subject: [PATCH] updated README --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae552d7..409ba56 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ # Texd -Bachelor assignment +###### Texd is a collaborative writing tool with support for extensions. The system can be run as a local server, and uses the strengths found in the MEAN-stack. +## About +The project was initially a bachelor assignment given at NTNU. +The project is based on ideas from document preparation systems such as latex and collaborative writing tools such as Google Docs. The project is trying take ideas from these systems and create a new way to think about documents. It is based on modern technology to see how that affects the development of such a system. +The foundation of the application is based on [MEAN Typescript Angular2 Skeleton](https://github.com/TeamTobb/MEAN-Typescript-Angular2-Skeleton). + +### Product features +* Realtime changes from all users in your document +* A new markup language for defining elements in the final document +* Rich text in the form of widgets +* Side by side text and preview +* Document preview in form of HTML +* Pretty print for PDF printing with page break on chapters +* Support for externally adding your own plugins (language extensions) + +### Technology features +* MongoDB +* Express +* Angular 2 +* Node.js +* Websockets +* Mongoose +* CodeMirror + +### Dependencies +* Node +* MongoDB + +See [enhancements](https://github.com/TeamTobb/Texd/labels/enhancement) for planned features. + +## Installation +See [installation guide](docs/running.md). + +## Plugins documentation +See [what are plugins](docs/plugins.md).