forked from TeamTobb/Texd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |