dpc commited on
Commit
e9db24c
1 Parent(s): 03f6769

edit read,e

Browse files
Files changed (1) hide show
  1. README.md +15 -107
README.md CHANGED
@@ -1,8 +1,18 @@
1
- Current version: 0.0.2 (Development Status :: 4 - Beta)
2
-
3
- Online demo [here]()
4
-
5
-
 
 
 
 
 
 
 
 
 
 
6
  ## palieasyread
7
 
8
  A quick and simple Python script to split Roman pali words into smaller syllables which are easier to be read.
@@ -17,105 +27,3 @@ It splits correctly most of the words, but NOT all. Some words may need your pos
17
 
18
  NOT recommended for beginers who have no idea how to pronounce a pali word. For example `gārayhā`, this script will split it: `gārayhā => gā ra yhā`.
19
 
20
-
21
- ## Installation
22
-
23
- ### Method 1
24
-
25
-
26
- ```
27
- python3 -m pip install git+https://github.com/vpnry/palieasyread.git#egg=palieasyread
28
-
29
- ```
30
-
31
- ### Method 2:
32
-
33
- Download [this repository](https://github.com/vpnry/palieasyread/archive/refs/heads/master.zip) unzip and run `python3 setup.py install` or import the `palieasyread` manually.
34
-
35
-
36
- ## Usage
37
-
38
- ### Syntax
39
-
40
- ```python
41
- easy_read(text, word_div=' / ', show_origin=True, syl_div=' ')
42
- ```
43
-
44
- ### Examples:
45
-
46
- ```python
47
-
48
- from palieasyread import easy_read
49
-
50
- text = '''
51
- Manopubbaṅgamā dhammā, manoseṭṭhā manomayā;
52
-
53
- Manasā ce paduṭṭhena, bhāsati vā karoti vā;
54
-
55
- Tato naṃ dukkhamanveti, cakkaṃva vahato padaṃ.
56
- '''
57
-
58
- ```
59
-
60
- #### Example 1
61
-
62
- Using default settings:
63
-
64
- ```python
65
-
66
- print(easy_read(text))
67
-
68
- ```
69
-
70
- Output example 1
71
-
72
- ```
73
- [Ma no pub baṅ ga mā] [dham mā,] [ma no seṭ ṭhā] [ma no ma yā;]
74
-
75
- Manasā ce paduṭṭhena, bhāsati vā karoti vā;
76
- [Ma na sā] [ce] [pa duṭ ṭhe na,] [bhā sa ti] [vā] [ka ro ti] [vā;]
77
-
78
- Tato naṃ dukkhamanveti, cakkaṃva vahato padaṃ.
79
- [Ta to] [naṃ] [duk kha man ve ti,] [cak kaṃ va] [va ha to] [pa daṃ.]
80
- ```
81
-
82
- #### Example 2
83
- Changing word divider and NOT showing the orginal text
84
-
85
- ```python
86
-
87
- print(easy_read(text, word_div=' * ', show_origin=False))
88
-
89
- ```
90
-
91
- Output example 2
92
-
93
- ```
94
- Ma no pub baṅ ga mā * dham mā, * ma no seṭ ṭhā * ma no ma yā;
95
-
96
-
97
- Ma na sā * ce * pa duṭ ṭhe na, * bhā sa ti * vā * ka ro ti * vā;
98
-
99
-
100
- Ta to * naṃ * duk kha man ve ti, * cak kaṃ va * va ha to * pa daṃ.
101
- ```
102
-
103
- #### Example 3
104
- Changing word divider, syllable divider, and NOT showing the orginal text
105
-
106
- ```python
107
- print(easy_read(text, word_div=' / ', show_origin=False, syl_div='.'))
108
-
109
- ```
110
-
111
- Output example 3
112
-
113
- ```
114
- Ma.no.pub.baṅ.ga.mā / dham.mā, / ma.no.seṭ.ṭhā / ma.no.ma.yā;
115
-
116
-
117
- Ma.na.sā / ce / pa.duṭ.ṭhe.na, / bhā.sa.ti / vā / ka.ro.ti / vā;
118
-
119
-
120
- Ta.to / naṃ / duk.kha.man.ve.ti, / cak.kaṃ.va / va.ha.to / pa.daṃ.
121
- ```
 
1
+ ---
2
+ title: palieasyread
3
+ emoji: 🦀
4
+ colorFrom: green
5
+ colorTo: pink
6
+ sdk: gradio
7
+ sdk_version: 3.0.20
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
+ Source code here:
13
+ [https://github.com/vpnry/palieasyread](https://github.com/vpnry/palieasyread)
14
+
15
+
16
  ## palieasyread
17
 
18
  A quick and simple Python script to split Roman pali words into smaller syllables which are easier to be read.
 
27
 
28
  NOT recommended for beginers who have no idea how to pronounce a pali word. For example `gārayhā`, this script will split it: `gārayhā => gā ra yhā`.
29