Skip to content

Commit

Permalink
Improve README and Makefile
Browse files Browse the repository at this point in the history
Resolves: #19
  • Loading branch information
mike-fabian committed Feb 8, 2024
1 parent 84335b9 commit f520016
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
6 changes: 4 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ PWD := $(shell pwd)
SRCDIR=$(PWD)

.PHONY: gzip
gzip:
gzip --keep --force --best langtable/data/*.xml
gzip: langtable/data/keyboards.xml.gz langtable/data/languages.xml.gz langtable/data/territories.xml.gz langtable/data/timezones.xml.gz langtable/data/timezoneidparts.xml.gz

.PHONY: test
test: gzip
Expand Down Expand Up @@ -67,6 +66,9 @@ review: mockbuild
cp *.spec ./mockbuild-results/
(cd ./mockbuild-results/; fedora-review -n langtable -m $(MOCK_CONFIG) )

%.xml.gz: %.xml
gzip --keep --force --best $< $@

# .rnc files for editing with Emacs
# https://fedoraproject.org/wiki/How_to_use_Emacs_for_XML_editing
%.rnc: %.rng
Expand Down
16 changes: 10 additions & 6 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,7 @@ To create a distribution tarball run

To run the test cases in the source directory:

make test-local

To run the test cases using the installed files:

make install DESTDIR=/usr
make test DESTDIR=/usr
make test

How to use it
=============
Expand All @@ -54,6 +49,7 @@ Functions in the public API:
list_locales()
list_keyboards()
list_common_languages()
list_common_locales()
list_common_keyboards()
list_consolefonts()
list_inputmethods()
Expand All @@ -65,6 +61,14 @@ Functions in the public API:
languageId()
territoryId()
supports_ascii()
list_all_languages()
list_all_locales()
list_all_keyboards()
list_all_territories()
list_all_timezones()
list_all_scripts()
list_all_input_methods()
list_all_console_fonts()

Some examples to show the usage are found in the documentation
of the public functions in langtable.py.
Expand Down

0 comments on commit f520016

Please sign in to comment.