diff --git a/README.md b/README.md index d7f19af..0d42811 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Support for these IRCds exist, but are not tested as frequently and thoroughly. 1) Install PyLink by using `python3 setup.py install` (global install) or `python3 setup.py install --user` (local install) -2) Rename `example-conf.yml` to `config.yml` and configure your instance there. Note that the configuration format isn't finalized yet - this means that your configuration may break in an update! +2) Rename `example-conf.yml` to `pylink.yml` and configure your instance there. Note that the configuration format isn't finalized yet - this means that your configuration may break in an update! 3) Run `pylink` from the command line. diff --git a/conf.py b/conf.py index 920ac1c..b85bbe3 100644 --- a/conf.py +++ b/conf.py @@ -1,16 +1,8 @@ """ conf.py - PyLink configuration core. -This module is used to access the complete configuration for the current -PyLink instance. It will load the config on first import, taking the -configuration file name from the first command-line argument, but defaulting -to 'config.yml' if this isn't given. - -If world.testing is set to True, it will return a preset testing configuration -instead. - -This module also provides simple checks for validating and loading YAML-format -configurations from arbitrary files. +This module is used to access the configuration of the current PyLink instance. +It provides simple checks for validating and loading YAML-format configurations from arbitrary files. """ import yaml diff --git a/example-conf.yml b/example-conf.yml index a58ddb3..6eeb2d9 100644 --- a/example-conf.yml +++ b/example-conf.yml @@ -1,4 +1,4 @@ -# This is a sample configuration file for PyLink. You'll likely want to rename it to config.yml +# This is a sample configuration file for PyLink. You'll likely want to rename it to pylink.yml # and begin your configuration there. # Note: lines starting with a "#" are comments and will be ignored. diff --git a/utils.py b/utils.py index 91283fc..664db5b 100644 --- a/utils.py +++ b/utils.py @@ -138,7 +138,7 @@ def getDatabaseName(dbname): current PyLink instance. This returns '.db' if the running config name is PyLink's default - (config.yml), and '-.db' for anything else. For example, + (pylink.yml), and '-.db' for anything else. For example, if this is called from an instance running as './pylink testing.yml', it would return '-testing.db'.""" if conf.confname != 'pylink':