Skip to content
Snippets Groups Projects
Commit 7651af44 authored by Eugen Ciur's avatar Eugen Ciur
Browse files

README updates

parent cf308760
No related branches found
No related tags found
No related merge requests found
......@@ -4,6 +4,7 @@ PapermergeJS is frontend part i.e. web-based user interface of Papermerge
Document Management System. It is meant to be used in conjunction with
[Papermerge REST API backend server](https://github.com/papermerge/papermerge-core).
## What is Papermerge DMS?
Papermerge is an open source document management system (DMS) designed
......@@ -11,15 +12,18 @@ for **digital archives**. Instead of having piles of paper documents all over
your desk, office or drawers - you can quickly scan them and configure your
scanner to directly upload to Papermerge DMS.
## What is a Digital Archive?
Simply put a digital archive is a scanned document. In broader sense, digital
archives are documents whose content does not change in time; a good example of
such documents are PDF files. If you take a picture of a document, you'll end
such **documents are PDF files**. If you take a picture of a document, you'll end
up with a "scanned document" in png, jpeg or whatever format that picture is
stored. In context of papermerge a picture of a document made with you mobile
phone is also a digital archive.
Papermerge **supports pdf, jpeg, png and tiff** file formats.
## Prerequisites
......@@ -32,12 +36,14 @@ development mode, you will need some extras:
Technically speaking, PapermergeJS is written using [EmberJS](https://emberjs.com/) web framework.
## Installation
* `git clone git@github.com:papermerge/papermerge.js.git` this repository
* `cd papermerge.js`
* `npm install`
## Running / Development
* `ember serve`
......@@ -50,10 +56,12 @@ Technically speaking, PapermergeJS is written using [EmberJS](https://emberjs.co
* `ember test`
* `ember test --server`
### Linting
* `npm run lint`
### Building
* `ember build` (development)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment