update readme and man page

This commit is contained in:
Vlasta Vesely 2020-01-13 19:59:32 +01:00
parent e609e13979
commit f736997361
2 changed files with 25 additions and 14 deletions

23
README
View file

@ -1,12 +1,23 @@
Sanskrit Transliteration Tool
=============================
This is a tool for romanisation of Sanskrit texts written in the Devanagari
script. The program offers you two different modes of transliteration: by
default, it transliterates a Devanagari text using the International Alphabet
of Sanskrit Transliteration (IAST); alternatively, it can be used for
simplified transcription into Czech language.
script.
The program offers you two different modes of transliteration: by default, it
romanises Sanskrit texts written in the Devanagari script using the
International Alphabet of Sanskrit Transliteration (IAST); alternatively it
can be used for reverse transliteration of IAST encoded texts into the
Devanagari script.
Licensing notice
Licensing Notice
----------------
This software is released under the GPL License, version 2.
This software is released under the terms of the GPL license version 2 as
published by the Free Software Foundation. You can freely redistribute and/or
modify the software under the terms of the license.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
For more information on details of the license, see the file COPYING.

View file

@ -10,7 +10,7 @@ iast - a helper for Sanskrit transliteration
SYNOPSIS
--------
--------------------------------------------------------------------------------
iast [-h] [-v] [-e] [-c] [--] [text arguments]
iast [-h] [-v] [-f file] [-r] [-e] [-c] [text arguments]
--------------------------------------------------------------------------------
OPTIONS
@ -21,6 +21,9 @@ show help and exit
*-v*::
show version number and exit
*-f*::
input file for processing
*-r*::
reverse transliteration (from Latin to Devanagari)
@ -30,9 +33,6 @@ transcript into Czech
*-e*::
convert symbolic ASCII text to IAST representation
*--*::
read data from the standard input
DESCRIPTION
-----------
@ -63,14 +63,14 @@ shortcuts to encode the letters "ā", "ī", "ū", "ś" and "ñ" respectively.
COPYRIGHT
---------
Copyright (c) 2018, 2020 Vlasta Vesely
Copyright (c) 2018, 2020 Vlasta Vesely <vlastavesely@protonmail.ch>
LICENSING AND WARRANTY
----------------------
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as published
by the Free Software Foundation.
This software is released under the terms of the GPL license version 2 as
published by the Free Software Foundation. You can freely redistribute and/or
modify the software under the terms of the license.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS