浏览代码

Expand description in README and user guide.

scossu 21 小时之前
父节点
当前提交
86004e42bc
共有 2 个文件被更改,包括 52 次插入21 次删除
  1. 26 11
      README.md
  2. 26 10
      doc/user_guide/docs/index.md

+ 26 - 11
README.md

@@ -14,20 +14,35 @@ small- to medium-(?) sized archives. It is designed to function in environments
 with unreliable connectivity and requires very low technical and human
 with unreliable connectivity and requires very low technical and human
 resources to set up, run, and use.
 resources to set up, run, and use.
 
 
-Pocket Archive fulfills the following functions:
+Pocket Archive fulfills the following business functions:
 
 
 - Storage and management of files and metadata-only resources
 - Storage and management of files and metadata-only resources
 - Management of descriptive, administrative, and technical metadata
 - Management of descriptive, administrative, and technical metadata
-- Dynamic relationships between resources
-- Static site generation (discovery interface)
-
-In spite of its design simplicity, Pocket Archive strives to be highly
-flexible. It is based on [Volksdata
-](https://git.knowledgetx.com/scossu/volksdata), a very compact Linked Data
-store and manipulation library. There is no restriction to the types and schema
-of metadata allowed, or the file types supported. A file-based configuration
-allows to set up content types and validation rules, or to have (almost) no
-rules at all.
+- Static site generation (presentation)
+
+Some interesting features it currently provides (or plans to implement soon):
+
+- Content creation and update are done by pushing spreadsheets (CSV) to a drop
+  box
+- Fully implementing Linked Data under the hood, hiding its ugly parts from the
+  end user
+- Higly customizable content model
+- User-definable relationships between resources
+- Able to run presentation site without an Internet connection
+
+In spite of its design simplicity, Pocket Archive strives to be flexible. It is
+based on [Volksdata](https://git.knowledgetx.com/scossu/volksdata), a very
+compact Linked Data store and manipulation library. There is no restriction to
+the types and schema of metadata allowed, or the file types supported. A
+file-based configuration allows to set up content types and validation rules,
+or to have (almost) no rules at all.
+
+Pocket Archive is designed to reinvent as little as possible and to use
+standard tools found in open source operating systems to provide a full
+management and preservation environment. It creates and updates resources using
+spreadsheets instead of running a web user interface; it writes all contents to
+disk and metadata in an embedded database that can be archived, replicated,
+backed up, and restored with reliable UNIX tools such as `tar`, `rsync`, etc.
 
 
 ## Documentation
 ## Documentation
 
 

+ 26 - 10
doc/user_guide/docs/index.md

@@ -14,19 +14,35 @@ small- to medium-(?) sized archives. It is designed to function in environments
 with unreliable connectivity and requires very low technical and human
 with unreliable connectivity and requires very low technical and human
 resources to set up, run, and use.
 resources to set up, run, and use.
 
 
-Pocket Archive fulfills the following functions:
+Pocket Archive fulfills the following business functions:
 
 
 - Storage and management of files and metadata-only resources
 - Storage and management of files and metadata-only resources
 - Management of descriptive, administrative, and technical metadata
 - Management of descriptive, administrative, and technical metadata
-- Dynamic relationships between resources
-- Static site generation (discovery interface)
-
-In spite of its design simplicity, Pocket Archive strives to be highly
-flexible. It is based on [Volksdata
-](https://git.knowledgetx.com/scossu/volksdata), a very compact Linked Data
-store written in C. There is no restriction to the types and schema of metadata
-allowed, or the file types supported. A file-based configuration allows to set
-up content types and validation rules, or to have (almost) no rules at all.
+- Static site generation (presentation)
+
+Some interesting features it currently provides (or plans to implement soon):
+
+- Content creation and update are done by pushing spreadsheets (CSV) to a drop
+  box
+- Fully implementing Linked Data under the hood, hiding its ugly parts from the
+  end user
+- Higly customizable content model
+- User-definable relationships between resources
+- Able to run presentation site without an Internet connection
+
+In spite of its design simplicity, Pocket Archive strives to be flexible. It is
+based on [Volksdata](https://git.knowledgetx.com/scossu/volksdata), a very
+compact Linked Data store and manipulation library. There is no restriction to
+the types and schema of metadata allowed, or the file types supported. A
+file-based configuration allows to set up content types and validation rules,
+or to have (almost) no rules at all.
+
+Pocket Archive is designed to reinvent as little as possible and to use
+standard tools found in open source operating systems to provide a full
+management and preservation environment. It creates and updates resources using
+spreadsheets instead of running a web user interface; it writes all contents to
+disk and metadata in an embedded database that can be archived, replicated,
+backed up, and restored with reliable UNIX tools such as `tar`, `rsync`, etc.
 
 
 ## Why
 ## Why