Mercurial > hgrepos > Python > libs > ConfigMix

changeset 92:75738d488e9d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Extended the README.txt about the high-level workings of the package
author Franz Glasner <hg@dom66.de>
date Sun, 18 Mar 2018 14:21:48 +0100
parents 5ca36fbea43d
children 84b9578cacce
files README.txt
diffstat 1 files changed, 13 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Sat Mar 17 18:59:14 2018 +0100
+++ b/README.txt	Sun Mar 18 14:21:48 2018 +0100
@@ -1,20 +1,30 @@
 .. -*- coding: utf-8; mode: rst; -*-
 
-.. _README:   
+.. _README:
 
 :Author:     Franz Glasner
-:Version:    |release|	   
+:Version:    |release|
 :Date:       |today|
 :Copyright:  (c) 2015–2018, Franz Glasner.
              All rights reserved.
 :License:    3-clause BSD License.
              See :ref:`LICENSE.txt <license>` for more details.
-:Revision:   |VCSRevision|	   
+:Revision:   |VCSRevision|
 :Repository: |VCSHGpath|
 
 
 "ConfigMix" is a library for helping with configuration files.
 
+It reads configuration files in the following styles:
+
+- YAML files
+- INI files
+- executable Python files
+
+It then merges them together into a tree-ish configuration dictionary and
+presents them as such to the API user. Reading can be done with
+keyword expansion from other configuration values.
+
 
 Further References and Inspirations
 -----------------------------------