From 8b1a701b28b20349844a52e7aed6886577da2ac5 Mon Sep 17 00:00:00 2001 From: King_DuckZ Date: Fri, 8 Jul 2016 12:42:44 +0100 Subject: [PATCH] List of libraries and commands --- Program-structure.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 Program-structure.md diff --git a/Program-structure.md b/Program-structure.md new file mode 100644 index 0000000..b3068c9 --- /dev/null +++ b/Program-structure.md @@ -0,0 +1,17 @@ +# Components +## Overview +This is the list of libraries in alphabetical order that make up dinder: + +* **common** common functionalities shared among the CLI programs and specific to them +* **machinery** the core functionalities of dindexer, which are needed if you are implementing a different frontend +* **main** the main command line program that is used by the end user - it simply execs the requested command +* **pq** wrapper around PostgreSQL C library, providing access to the features used by dindexer +* **helpers** header-only library with generic code and no dependencies on other components + +Commands are listed separately for clarity: + +* **delete** deletes content from the database +* **locate** perform searches into the database +* **navigate** navigate through the database similarly to how you would in bash +* **scan** scan and store a directory into the database +* **tag** tag or untag content in the database \ No newline at end of file