|
3 | 3 |
|
4 | 4 | An inclusive transpiler which lets you write Python code in any human language. |
5 | 5 |
|
6 | | -## Pre-requisites |
7 | | -- Python 3+ |
8 | | -- Pip |
9 | | -- (optional but recommended) Virtual environment, like ```conda``` or ```virtualenv``` |
10 | | - |
11 | 6 | ## Why? |
12 | 7 | Just look at how beautiful it is :) |
13 | 8 |
|
14 | 9 | ### Side by Side Comparison of UniversalPython vs Python |
15 | 10 |  |
16 | 11 |
|
17 | 12 | ### It works! |
18 | | - |
| 13 | + |
19 | 14 |
|
20 | 15 | ## How to Install |
21 | 16 | ### Pip |
22 | 17 | If you've installed ```pip```, you can install UniversalPython from [Test PyPI](https://test.pypi.org/project/universalpython/) using the following command: |
23 | 18 | ``` |
24 | | -pip install -i https://test.pypi.org/pypi/ --extra-index-url https://pypi.org/simple universalpython |
25 | | -``` |
26 | | - |
27 | | -### Source |
28 | | -1. Download this repo as a ZIP, or clone it via Git. |
29 | | -2. Open the repo's folder in your Terminal. |
30 | | -3. Run ```pip install -e .``` |
31 | | - |
32 | | -## How to Use |
33 | | -1. Create a new file in a folder. |
34 | | -2. Write some Urdu code in this new file. |
35 | | -The mappings are as following: |
36 | | - |
37 | | -| Python (original) | 🇵🇰 Ur | |
38 | | -| ------------- | ------------- | |
39 | | -| ```print``` | لکھو| |
40 | | -| ```if``` | اگر| |
41 | | -| ```elif``` | ورنہاگر| |
42 | | -| ```else``` | ورنہ| |
43 | | -| ```while``` | جبتک| |
44 | | -| ```for``` | جو| |
45 | | -| ```in``` | اندر| |
46 | | -| ```input``` | داخله| |
47 | | -| ```break``` | توڑ| |
48 | | -| ```continue``` | جاری| |
49 | | -| ```pass``` | گزر| |
50 | | -| ```True``` | حق| |
51 | | -| ```False``` | باطل| |
52 | | -| ```is``` | ہے| |
53 | | -| ```class``` | طبقه| |
54 | | -| ```def``` | وضح| |
55 | | -| ```init``` | ابتدا| |
56 | | -| ```self``` | خود| |
57 | | -| ```return``` | واپس| |
58 | | -| ```string``` | ستلی| |
59 | | -| ```str``` | ستل| |
60 | | -| ```append``` | شامل| |
61 | | -| ```pop``` | نکل| |
62 | | -| ```and``` | اور| |
63 | | -| ```or``` | یا| |
64 | | -| ```all``` | سب| |
65 | | -| ```any``` | کوئ| |
66 | | -| ```None``` | ندارد |
67 | | -| ```,``` | ، | |
68 | | -| ```.``` | ۔| |
69 | | -| ```0``` | ۰| |
70 | | -| ```1``` | ۱| |
71 | | -| ```2``` | ۲| |
72 | | -| ```3``` | ۳| |
73 | | -| ```4``` | ۴| |
74 | | -| ```5``` | ۵| |
75 | | -| ```6``` | ۶| |
76 | | -| ```7``` | ۷| |
77 | | -| ```8``` | ۸| |
78 | | -| ```9``` | ۹| |
79 | | - |
80 | | -Find the whole list of keywords [here](./universalpython/languages/ur/ur_native.lang.yaml). Don't worry if you can't find a mapping, you can also use English Python! |
81 | | - |
82 | | -An example of a Hello World Program: |
83 | | -``` |
84 | | -print ("Hello world!") |
85 | | -``` |
86 | | -would be |
| 19 | +pip install -i urdupython |
87 | 20 | ``` |
88 | | -لکھو ("Hello world!") |
89 | | -``` |
90 | | -There are many more sample codes available [here](./universalpython/samples) |
91 | | - |
92 | | -3. Open a Terminal in the folder of this file. |
93 | | -4. Run the code in one command: ```universalpython <NAME_OF_YOUR_FILE>``` |
94 | | - |
95 | | -For more help, run ```universalpython --help```. For better understanding, do run the sample code files in the "samples" folder. |
96 | | - |
97 | | -## Guide |
98 | | -### For macOS |
99 | | -- Use TextEdit (default text editor) to write Urdu code. |
100 | | -- Activate right-to-left typing through Menu: Format->Text->Writing Direction->Right-to-Left |
101 | | - |
102 | | -### For Windows |
103 | | -- Download and install Notepad++. |
104 | | -- Right click and activate RTL (Right-to-left). |
105 | 21 |
|
106 | | -### For Linux |
107 | | -Open gEdit (or any similar text-editing program), and start coding right away. |
| 22 | +## Learn more |
| 23 | +Read up the docs at our [documentation website](https://universalpython.github.io/docs/). |
108 | 24 |
|
109 | 25 | ## Tests |
110 | 26 | ### Platform(s) tested on |
|
0 commit comments