Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
john30 committed Dec 29, 2024
1 parent 7121892 commit e4e1c2c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ This is a service providing configuration files for [ebusd](https://github.com/j

The CSV files currently consumed by [ebusd](https://github.com/john30/ebusd) are generated from TypeSpec source files found in the [`src` folder of ebusd-configuration](https://github.com/john30/ebusd-configuration/tree/master/src) and converted to CSV using the [eBUS TypeSpec library](https://github.com/john30/ebus-typespec). The conversion process is described there in detail.

The mapping from source files to generated CSV files is also re-generated with each update and [documented here](mapping.md).
The source files are taken from the commit associated with the submodule [ebusd-configuration](ebusd-configuration) here and the mapping from those to the generated CSV files is also re-generated with each update and [documented here](mapping.md).

Take a look in the [`next/` folder](next/) for using the next upcoming release of the main folder.
4 changes: 4 additions & 0 deletions next/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Description
This folder contains the next upcoming release of the main folder and can be used for inspection by pointing ebusd to the base folder with the "--configpath=https://ebus.github.io/next/" argument to ebusd.

The source files are taken from the commit associated with the submodule [ebusd-configuration-next](../ebusd-configuration-next) here and the mapping from those to the generated CSV files is also re-generated with each update and [documented here](mapping.md).

0 comments on commit e4e1c2c

Please sign in to comment.