Minor edits (#276)

* fix : font_wizard.py updated * doc : CONTRIBUTING.md updated * doc : badges bug fixed * doc : CHANGELOG.md updated * doc : minor edit in RELEASE.md * doc : minor edit in RELEASE.md * doc : last updated added to CONTRIBUTING.md * doc : install section in CONTRIBUTING.md updated
sepandhaghighi · Sep 11, 2024 · 072f329 · 072f329
1 parent 9ac4048
commit 072f329
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 46 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,4 +1,6 @@
-# Contribution			
+# Contribution
+
+**Last Update: 2024-09-10**		
 
 Changes and improvements are more than welcome! ❤️ Feel free to fork and open a pull request.
 
@@ -12,8 +14,8 @@ Please consider the following :
 	- To add a new decoration visit [here](#decoration)
 4. Add standard `docstring` to your functions
 5. Add tests for new features (`doctest`)
-	- **ASCII** fonts/arts in `test.py`
-	- Other in `test2.py`
+	- **ASCII** fonts/arts in `tests/test.py`
+	- Other in `tests/test2.py`
 6. Update `README.md` (if needed)
 7. Pass all CI tests
 8. Update `CHANGELOG.md`
@@ -27,7 +29,7 @@ Please consider the following :
 ## Font
 
 1. Select a non-duplicate name
-2. Add new font data as a dictionary to the end of `text_dic3.py` (support 95 printable **ASCII** characters)
+2. Add new font data as a dictionary to the end of `data/fonts3.py` (support 95 printable **ASCII** characters)
 	- You can use `font_wizard.py` in `otherfile` folder (need to install latest version of `art` package)
 3. Map font name and data in `FONT_MAP` dictionary
 4. Select case sensitive mode in `FONT_MAP` dictionary
@@ -38,13 +40,13 @@ Please consider the following :
 	- Add font name to `UPPERCASE_FONTS`
 6. If font is **Non-ASCII**:
 	- Add font name to `NON_ASCII_FONTS` list
-	- Add a test case to `test2.py` (*Alphabetical order*)
+	- Add a test case to `tests/test2.py` (*Alphabetical order*)
 	- Add font name to `MIX_FILTERED_FONTS` list to remove it from mix mode (*Optional*)
 7. If font is **ASCII**:
-	- Add a test case to `test.py` (*Alphabetical order*)  
+	- Add a test case to `tests/test.py` (*Alphabetical order*)  
 	- Add font name to `RANDOM_FILTERED_FONTS` list to remove it from random modes (*Optional*)
 8. Re-run `FontList.ipynb`
-	- Before this step you should re-install `art` package : ```python setup.py install```
+	- Before this step you should re-install `art` package : ```pip install .```
 9. Update 2 font counters in `README.md`
 	- Badge section
 	- Overview section
@@ -55,16 +57,16 @@ Please consider the following :
 ## 1-Line art
 
 1. Select a non-duplicate name
-2. Add 1-line art to the end of ‍`art_dic` dictionary in `art_dic.py`
+2. Add 1-line art to the end of ‍`art_dic` dictionary in `data/arts.py`
 	- Add as string (Example : ```"1-line art name": "string"```)
 3. If 1-line art is **Non-ASCII**:
 	- Add 1-line art name to `NON_ASCII_ARTS` list
-	- Add a test case to `test2.py` (*Alphabetical order*)
+	- Add a test case to `tests/test2.py` (*Alphabetical order*)
 4. If 1-line art is **ASCII**:
-	- Add a test case to `test.py` (*Alphabetical order*)
+	- Add a test case to `tests/test.py` (*Alphabetical order*)
 	- Add 1-line art name to `RANDOM_FILTERED_ARTS` list to remove it from random mode (*Optional*)
 5. Re-run `ArtList.ipynb`
-	- Before this step you should re-install `art` package : ```python setup.py install```
+	- Before this step you should re-install `art` package : ```pip install .```
 6. Update 2 art counters in `README.md`
 	- Badge section
 	- Overview section
@@ -73,11 +75,11 @@ Please consider the following :
 ## Decoration
 
 1. Select a non-duplicate name
-2. Add new decoration data as a list to the end of `decor_dic.py`
+2. Add new decoration data as a list to the end of `data/decorations.py`
 3. Map decoration name and data in `DECORATIONS_MAP` dictionary
-4. Add a test case to `test2.py` (*Alphabetical order*)
+4. Add a test case to `tests/test2.py` (*Alphabetical order*)
 5. Re-run `DecorList.ipynb`
-	- Before this step you should re-install `art` package : ```python setup.py install```
+	- Before this step you should re-install `art` package : ```pip install .```
 6. Update 2 decor counters in `README.md`
 	- Badge section
 	- Overview section

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Tests moved to `tests` directory
 - `Python 3.5` support dropped
 - Test system modified
+- `CONTRIBUTING.md` updated
+- `README.md` modified
 ## [6.2] - 2024-04-22
 ### Added
 - 5 new font

diff --git a/README.md b/README.md
@@ -2,33 +2,15 @@
 	<img src="https://github.com/sepandhaghighi/art/raw/master/otherfile/logo.png" alt="Logo">
 	<br/>
 	<br/>
-	<a href="https://codecov.io/gh/sepandhaghighi/art">
-		<img src="https://codecov.io/gh/sepandhaghighi/art/branch/master/graph/badge.svg" alt="Codecov" />
-	</a>
-	<a href="https://badge.fury.io/py/art">
-		<img src="https://badge.fury.io/py/art.svg" alt="PyPI" height="18">
-	</a>
-	<a href="https://www.python.org/">
-		<img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3">
-	</a>
-	<a href="https://github.com/sepandhaghighi/art/blob/master/FontList.ipynb">
-		<img src="https://img.shields.io/badge/Font List-667-blue.svg" alt="Font List">
-	</a>
-	<a href="https://github.com/sepandhaghighi/art/blob/master/ArtList.ipynb">
-		<img src="https://img.shields.io/badge/Art List-710-orange.svg" alt="Art List">
-	</a>
-	<a href="https://github.com/sepandhaghighi/art/blob/master/DecorList.ipynb">
-		<img src="https://img.shields.io/badge/Decor List-218-green.svg" alt="Decor List">
-	</a>
-	<a href="https://t.me/artlib_bot" target="__blank">
-		<img src="https://img.shields.io/badge/Telegram-Bot-red.svg" alt="Telegram Bot">
-	</a>
-	<a href="https://anaconda.org/sepandhaghighi/art">
-		<img src="https://anaconda.org/sepandhaghighi/art/badges/version.svg" alt="Anaconda">
-	</a>
-	<a href="https://discord.com/invite/FAAyq3QJqP">
-		<img src="https://img.shields.io/discord/897532566301724722.svg" alt="Discord Channel">
-	</a>
+	<a href="https://codecov.io/gh/sepandhaghighi/art"><img src="https://codecov.io/gh/sepandhaghighi/art/branch/master/graph/badge.svg" alt="Codecov"></a>
+	<a href="https://badge.fury.io/py/art"><img src="https://badge.fury.io/py/art.svg" alt="PyPI" height="18"></a>
+	<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
+	<a href="https://github.com/sepandhaghighi/art/blob/master/FontList.ipynb"><img src="https://img.shields.io/badge/Font List-667-blue.svg" alt="Font List"></a>
+	<a href="https://github.com/sepandhaghighi/art/blob/master/ArtList.ipynb"><img src="https://img.shields.io/badge/Art List-710-orange.svg" alt="Art List"></a>
+	<a href="https://github.com/sepandhaghighi/art/blob/master/DecorList.ipynb"><img src="https://img.shields.io/badge/Decor List-218-green.svg" alt="Decor List"></a>
+	<a href="https://t.me/artlib_bot" target="__blank"><img src="https://img.shields.io/badge/Telegram-Bot-red.svg" alt="Telegram Bot"></a>
+	<a href="https://anaconda.org/sepandhaghighi/art"><img src="https://anaconda.org/sepandhaghighi/art/badges/version.svg" alt="Anaconda"></a>
+	<a href="https://discord.com/invite/FAAyq3QJqP"><img src="https://img.shields.io/discord/897532566301724722.svg" alt="Discord Channel"></a>
 </div>
 
 ----------

diff --git a/otherfile/RELEASE.md b/otherfile/RELEASE.md
@@ -1,7 +1,7 @@
 
 # Art Release Instructions
 
-#### Last Update: 2024-08-06
+**Last Update: 2024-09-10**
 
 1. Create the `release` branch under `dev`
 2. Update all version tags
@@ -41,7 +41,7 @@
 	6. Wait for all CI pass
 	7. Need review (**1** reviewer)
 11. Merge `dev` branch into `master`
-	1. Checkout to `master`
+	1. `git checkout master`
 	2. `git merge dev`
 	3. `git push origin master`
 	4. Wait for all CI pass

diff --git a/otherfile/font_wizard.py b/otherfile/font_wizard.py
@@ -150,14 +150,14 @@ def is_ascii(s):
                 font_dic,
                 ensure_ascii=False,
                 indent=4))
-        print("- Add this dictionary to the end of `text_dic3.py`")
+        print("- Add this dictionary to the end of `data/fonts3.py`")
         print("- This font is {0} : ".format(ascii_flag))
         print('\t1. Add "{0}": [{0}_dic, False] to the end of `FONT_MAP` dictionary in `params.py`'.format(
             font_name))
         if ascii_flag == "ASCII":
-            print("\t2. Add a new test case to `test.py`")
+            print("\t2. Add a new test case to `tests/test.py`")
         else:
-            print("\t2. Add a new test case to `test2.py`")
+            print("\t2. Add a new test case to `tests/test2.py`")
             print('\t3. Add "{0}" to the end of `NON_ASCII_FONTS` list in `params.py`'.format(
                 font_name))
             if font_height > 1: