Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
WatheqAlshowaiter committed Feb 10, 2024
1 parent 77205e2 commit 9443861
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
8 changes: 6 additions & 2 deletions README.en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Yemen-info

Here are some files for the most important information for Yemen programmatically. We have information about Yemeni governorates, districts and uzaal in both Arabic and English languages.
Here are some files for the most important information for Yemen programmatically. We have information about Yemeni governorates, districts, uzaal and villages in both Arabic and English languages.
The Arabic names are introduced in many forms: with Tashkeel, without it, and as a normalized text.
The English names are provided as close as possible to the Arabic name, and we have another format as a normalized text. These normalized texts are very useful for searching on the web or mobile applications.

Expand Down Expand Up @@ -28,7 +28,9 @@ This repository will help. Yes a little, but it is helpful!

- We made a normalized version for every governorate and district. Our methodology in Arabic text is by using [Ar-PHP](https://ar-php.org/github/examples/standard.php) algorithms for Arabic text normalization. For English text we have made changes to the text: 1. remove apostrophes ('), 2. replace dashes (-) with one blank space. All of this text normalization we made is to help get better results when searching either in Arabic or English.

- On February 10, we added a list of uzaal for each district. But the data is not accurate 100%, as is the case in the governorates and districts, and we also did not add the Tashkeel because we cannot verify them. We put the English name as we received it from the excel file, so, for example, we find in this English name the use of the name of the uzlah of “الزبيرات” with this English name “Az Zubayrat” instead of “ Al Zubayrat", we did not adhere to Tashkeel here as the districts because we are not sure of the accuracy of the data of the uzaal.
- On February 10th 2023, we added a list of uzaal for each district. But the data is not accurate 100%, as is the case in the governorates and districts, and we also did not add the Tashkeel because we cannot verify them. We put the English name as we received it from the excel file, so, for example, we find in this English name the use of the name of the uzlah of “الزبيرات” with this English name “Az Zubayrat” instead of “ Al Zubayrat", we did not adhere to Tashkeel here as the districts because we are not sure of the accuracy of the data of the uzaal.

- And on February 10th 2024, we added a list of villages for each uzlah, And what applies to the uzaal data applies also to the villages data.

## How to use it

Expand Down Expand Up @@ -66,6 +68,8 @@ You can also use the [cspell dictionary file Here](https://github.com/YemenOpenS

✅ Automate conversion scripts after any modification to `yemen-info.json` file using GitHub Action. So all data are in sync in all formats.

✅ Villages names for every uzlah (new).

# How To contribute

You can make an issue if you find any mistakes or you have any suggestions or create a pull request.
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

[English Readme](./README.en.md)

هنا بعض الملفات لأهم المعلومات المتعلقة باليمن من ناحية برمجية. لدينا معلومات عن محافظات اليمن ومديرياتها وعزلها باللغتين العربية والإنجليزية. قُدّمت الأسماء العربية للمحافظات والمديريات بعدة أشكال: بالتشكيل وبدونه، وحتى بصيغة موحّدة نمطية (normalized text).
هنا بعض الملفات لأهم المعلومات المتعلقة باليمن من ناحية برمجية. لدينا معلومات عن محافظات اليمن ومديرياتها وعزلها وقراها باللغتين العربية والإنجليزية. قُدّمت الأسماء العربية للمحافظات والمديريات بعدة أشكال: بالتشكيل وبدونه، وحتى بصيغة موحّدة نمطية (normalized text).
وقُدّمت الأسماء الإنجليزية بأقرب صورة ممكنة للاسم العربي، وبصيغة أخرى موحّدة كذلك.
هذه الصيغة الموحّدة مفيدة جدًا في البحث في تطبيقات الويب والجوال.

Expand Down Expand Up @@ -36,7 +36,9 @@

⦿ وحّدنا النصوص لكل محافظة ومديرية. في الأسماء العربية استخدمنا خوارزمية مكتبة [Ar-PHP](https://ar-php.org/github/examples/standard.php). وفي الأسماء الإنجليزية جعلنا التغييرات كالتالي: 1- حذف الفاصلة العليا (')، 2- استبدال الشرطة (-) بمسافة. كل هذه التغييرات المتعلقة بتوحيد النصوص أو كما يُقال تنميطها هي من أجل استرجاع نتائج أفضل في البحث باللغة العربية أو الإنجليزية.

⦿ في 10 فبراير، أضفنا قائمة بالعُزَل لكل مديرية. لكن البيانات ليست دقيقة كما هو الحال في المحافظات والمديريات، وكذلك لم نُضف التشكيلات لأننا لا نستطيع التأكد منها، ووضعنا التسمية الإنجليزية كما وردتنا في ملف الإكسل فنجد في هذه التسمية الإنجليزية استخدام تسمية عزلة "الزبيرات" بهذه التسمية الإنجليزية "Az Zubayrat" بدلًا من "Al Zubayrat"، فلم نلتزم بالتشكيل في العزل كما في المديريات لأننا غير متأكدين من دقة البيانات في العُزَل.
⦿ في 10 فبراير من العام 2023، أضفنا قائمة بالعُزَل لكل مديرية. لكن البيانات ليست دقيقة كما هو الحال في المحافظات والمديريات، وكذلك لم نُضف التشكيلات لأننا لا نستطيع التأكد منها، ووضعنا التسمية الإنجليزية كما وردتنا في ملف الإكسل فنجد في هذه التسمية الإنجليزية استخدام تسمية عزلة "الزبيرات" بهذه التسمية الإنجليزية "Az Zubayrat" بدلًا من "Al Zubayrat"، فلم نلتزم بالتشكيل في العزل كما في المديريات لأننا غير متأكدين من دقة البيانات في العُزَل.

⦿ وفي 10 فبراير من العام 2024، أضفنا قائمة بالقرى لكل عزلة، وينطبق على بيانات القرى ما ينطبق على بيانات العزل...

## كيفية الاستخدام

Expand Down Expand Up @@ -74,9 +76,7 @@

✅ أتمتة سكريبتات التحويل لمختلف الصيغ بعد أي تعديل لملف `yemen-info.json` عن طريق GitHub Action، بحيث تتزامن البيانات في مختلف الصيغ.

- القرى والحارات داخل كل عزلة (قريبا)
- التعداد السكاني لأقرب تعداد سكاني (قريبا)

✅ أسماء القرى داخل كل عزلة (جديد).

## كيفية المساهمة

Expand Down

0 comments on commit 9443861

Please sign in to comment.