# HG changeset patch # User Franz Glasner # Date 1521379308 -3600 # Node ID 75738d488e9d7471063dbfe8325e117f7ad1dd21 # Parent 5ca36fbea43d3451e28020099c2005c69682c848 Extended the README.txt about the high-level workings of the package diff -r 5ca36fbea43d -r 75738d488e9d README.txt --- 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 ` 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 -----------------------------------