Skip to content

Commit

Permalink
add notes to README.md for build, install and testing
Browse files Browse the repository at this point in the history
  • Loading branch information
ikluft committed Dec 12, 2024
1 parent 6befe33 commit ded6031
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions src/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ interface.
To do that, it provides the functions _utcoffset_, _dst_ and _tzname_.
It inherits the _fromutc_ function from tzinfo.

If the library is installed from source code from GitHub, use the Python flit command to build and install. It can be built with "flit built" and installed with "flit install".

Online resources
----------------

Expand Down
2 changes: 1 addition & 1 deletion src/python/timezone_solar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Source files:
* __init__.py - initialization for sources in timezone_solar module directory, loads the module
* timezone_solar.py - core of the timezone_solar module
* tzsconst.py - constants used by the timezone_solar module and its unit tests
* test (directory) - containts unit tests
* test (directory) - containts unit tests (to run tests, use the command line "python tests")
* __main__.py - allows running all the tests by running the test module/directory as a Python script
* test_010_tzsconst.py - unit tests for constants in tzsconst
* test_011_basic.py - basic unit tests of timezone_solar time zones for each longitude or hourly zone
Expand Down

0 comments on commit ded6031

Please sign in to comment.