From 18417a1f591fb454b50dc0e98c379eff23e8d9fb Mon Sep 17 00:00:00 2001 From: harrydowning Date: Wed, 17 May 2023 10:10:16 +0100 Subject: [PATCH] Changed description and version for new release --- README.md | 11 +++++++++-- docs/source/conf.py | 2 +- docs/source/index.rst | 9 +++------ docs/source/user_guide/cli.rst | 4 ++++ setup.cfg | 2 +- src/serl/constants.py | 2 +- 6 files changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 36b16b4..fa548e2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ -# Serialized Language (serl) -Serl is a command line tool used to manage and execute programming languages serialized with YAML. +# Serl - A tool for creating and using languages + + + + + + + +Serl (serialized languages) is a format and corresponding command line tool for creating and using textual domain specific or markup languages with arbitrary syntax. This is achieved through the concept of language configurations, which are YAML files for specifying language syntax and functionality, used by the tool to execute language programs. These configurations can then be linked, allowing languages to be used like any other command line tool. Documentation can be found on [Read The Docs](https://serl.readthedocs.io/en/latest/index.html). diff --git a/docs/source/conf.py b/docs/source/conf.py index 4e72f25..7048e64 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -9,7 +9,7 @@ project = 'Serl' copyright = '2023, Harry Downing' author = 'Harry Downing' -release = '0.2.2-beta' +release = '0.3.0-beta' master_doc = 'index' diff --git a/docs/source/index.rst b/docs/source/index.rst index 2a3c93d..c09fd4d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,12 +1,9 @@ Overview ======== -Serl is a command line tool used to manage and execute programming languages serialized with YAML. -The format of these language is specified in the :ref:`lang-config` section. - -.. - .. Note:: - At the moment the tool is in an early stage of its development and so its interface may change. +Serl (serialized languages) is a format and corresponding command line tool for creating and using textual domain specific or markup languages with arbitrary syntax. +This is achieved through the concept of :ref:`language configurations `, which are YAML files for specifying language syntax and functionality, used by the tool to execute language programs. +These configurations can then be :ref:`linked `, allowing languages to be used like any other command line tool. .. toctree:: :caption: Home diff --git a/docs/source/user_guide/cli.rst b/docs/source/user_guide/cli.rst index faf5899..abb8dd7 100644 --- a/docs/source/user_guide/cli.rst +++ b/docs/source/user_guide/cli.rst @@ -1,3 +1,5 @@ +.. _cli: + Command Line Interface ====================== @@ -28,6 +30,8 @@ The following usage pattern shows the tool's main interface. -v, --verbose Provide more output. +.. _link: + link ---- :Usage: diff --git a/setup.cfg b/setup.cfg index 74e3018..b0ccfc7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -3,7 +3,7 @@ name = serl version = attr: serl.constants.VERSION author = Harry Downing author_email = harry.downing17@gmail.com -description = Serialized Language (serl) +description = Serl - A tool for creating and using languages long_description = file: README.md, LICENSE long_description_content_type = text/markdown license = MIT diff --git a/src/serl/constants.py b/src/serl/constants.py index 2c53716..d397151 100644 --- a/src/serl/constants.py +++ b/src/serl/constants.py @@ -1,5 +1,5 @@ NAME = __package__ -VERSION = '0.2.2-beta' +VERSION = '0.3.0-beta' SYSTEM_CONFIG_DIR = f'.{NAME}' SYSTEM_CONFIG_ENV_DIR = 'environments'