diff --git a/README b/README index 3d680ea7d..ceaaa606b 100644 --- a/README +++ b/README @@ -12,3 +12,46 @@ See the file COPYING for more details. Documentation ------------- The project's documentation is at https://kanjivg.tagaini.net/. + +Releases +-------- + +The files in the release are as follows: + +* kanjivg-YYYYMMDD-main.zip + +This zip file contains all of the non-variant SVG files in the same +format as they were in the repository at the time the release was +made. This is the file which is recommended for most users who simply +want a set of SVG graphics they can use immediately. + +* kanjivg-YYYYMMDD-all.zip + +This zip file contains all of the SVG files, including the variant +forms, in the same format as they were in the repository at the time +the release was made. + +* kanjivg-YYYYMMDD.xml.gz + +The file kanjivg-YYYYMMDD.xml.gz contains all of the non-variant SVG +files in one large XML structure. This is the format in which KanjiVG +was first released. However, although this format will not be removed, +it should now be considered obsolete, and is only provided for users +who want to keep using "legacy" software written with the old +format. This file is generated by `kvg.py`. + +* Source code files + +These are the entire repository's source code files. These are +generated by github. + +Utilities +--------- + +The main utility is `kvg.py`. Releases are generated using the +`updatepublic.sh` shell script. There is some Python library code in +`kanjivg.py` for manipulating the files. The file `make-index.pl` is +for making an index of the kanji files called `kvg-index.json` which +is used by the viewer at the kanjivg website. Unfortunately this needs +to be part of this repository in order that the Javascript viewer can +work properly. diff --git a/kvg.py b/kvg.py index 960d267ae..bf452bfc2 100755 --- a/kvg.py +++ b/kvg.py @@ -67,6 +67,8 @@ def release(): allfiles = os.listdir(datadir) files = [] for f in allfiles: + # This rejects the variant files by only choosing + # files with length of 9, for 0abcd.svg style files. if len(f) == 9: files.append(f) del allfiles files.sort() @@ -75,7 +77,7 @@ def release(): out.write('\n') out.write("\n") out.write("\n") for f in files: diff --git a/updatepublic.sh b/updatepublic.sh index 849b6e84d..b75f673fa 100755 --- a/updatepublic.sh +++ b/updatepublic.sh @@ -7,5 +7,3 @@ zip -r $outFileAll kanji/*.svg zip -r $outFileMain kanji/?????.svg ./kvg.py release gzip -c kanjivg.xml >$outFileOne -#scp $outFileOne $outFileAll gnurou@gnurou.org:/srv/http/kanjivg/upload/Main/ -#ssh gnurou@gnurou.org "ln -sf $outFileOne /srv/http/kanjivg/upload/Main/kanjivg-latest.xml.gz"