Skip to content

Commit af37360

Browse files
committed
docs: Revise README in English
1 parent 1c3b728 commit af37360

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ https://github.com/ZZHow1024/MagicEncoding/releases
1818

1919
---
2020

21+
## What is it?
22+
23+
MagicEncoding is a cross-platform encoding processing tool that supports character set conversion of character files, encoding and decoding of character text (Unicode and URL) and Unix timestamps (conversion between timestamps and time and shortcut operations on time).
24+
25+
---
26+
2127
## License
2228

2329
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
@@ -26,6 +32,8 @@ This project is licensed under the GNU General Public License v3.0 - see the [LI
2632

2733
## **Instructions for use**
2834

35+
Download address: https://github.com/ZZHow1024/MagicEncoding/releases
36+
2937
- Determine the operating system you are using.
3038
- Linux:
3139
- Select .deb installation package/ .rpm installation package.
@@ -65,7 +73,23 @@ This project is licensed under the GNU General Public License v3.0 - see the [LI
6573

6674
---
6775

68-
## Function Introduction
76+
## Supported file character sets
77+
78+
- Supported file character sets for conversion: Big5, Big5-HKSCS, CESU-8, EUC-JP, EUC-KR, GB18030, GB2312, GBK, IBM-Thai, IBM00858, IBM01140, IBM01141, IBM01142, IBM01143, IBM01144, IBM01145, IBM01146, IBM01147, IBM01148, IBM01149, IBM037, IBM1026, IBM1047, IBM273, IBM277, IBM278, IBM280, IBM284, IBM285, IBM290, IBM297, IBM420, IBM424, IBM437, IBM500, IBM775, IBM850, IBM852, IBM855, IBM857, IBM860, IBM861, IBM862, IBM863, IBM864, IBM865, IBM866, IBM868, IBM869, IBM870, IBM871, IBM918, ISO-2022-CN, ISO-2022-JP, ISO-2022-JP-2, ISO-2022-KR, ISO-8859-1, ISO-8859-13, ISO-8859-15, ISO-8859-16, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, JIS_X0201, JIS_X0212-1990, KOI8-R, KOI8-U, Shift_JIS, TIS-620, US-ASCII, UTF-16, UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE, UTF-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-31j, x-Big5-HKSCS-2001, x-Big5-Solaris, x-euc-jp-linux, x-EUC-TW, x-eucJP-Open, x-IBM1006, x-IBM1025, x-IBM1046, x-IBM1097, x-IBM1098, x-IBM1112, x-IBM1122, x-IBM1123, x-IBM1124, x-IBM1129, x-IBM1166, x-IBM1364, x-IBM1381, x-IBM1383, x-IBM29626C, x-IBM300, x-IBM33722, x-IBM737, x-IBM833, x-IBM834, x-IBM856, x-IBM874, x-IBM875, x-IBM921, x-IBM922, x-IBM930, x-IBM933, x-IBM935, x-IBM937, x-IBM939, x-IBM942, x-IBM942C, x-IBM943, x-IBM943C, x-IBM948, x-IBM949, x-IBM949C, x-IBM950, x-IBM964, x-IBM970, x-ISCII91, x-ISO-2022-CN-CNS, x-ISO-2022-CN-GB, x-iso-8859-11, x-JIS0208, x-JISAutoDetect, x-Johab, x-MacArabic, x-MacCentralEurope, x-MacCroatian, x-MacCyrillic, x-MacDingbat, x-MacGreek, x-MacHebrew, x-MacIceland, x-MacRoman, x-MacRomania, x-MacSymbol, x-MacThai, x-MacTurkish, x-MacUkraine, x-MS932_0213, x-MS950-HKSCS, x-MS950-HKSCS-XP, x-mswin-936, x-PCK, x-SJIS_0213, x-UTF-16LE-BOM, X-UTF-32BE-BOM, X-UTF-32LE-BOM, x-windows-50220, x-windows-50221, x-windows-874, x-windows-949, x-windows-950, x-windows-iso2022jp.
79+
- Supports automatic identification of file character sets:[Encodings that can be detected](https://github.com/albfernandez/juniversalchardet?tab=readme-ov-file#encodings-that-can-be-detected).
80+
81+
---
82+
83+
## Dependencies
84+
85+
This project requires the following libraries:
86+
87+
- [**juniversalchardet**](https://github.com/albfernandez/juniversalchardet): Used for character encoding detection.
88+
- [**OpenJFX**](https://openjfx.io/): JavaFX library for building the graphical user interface.
89+
90+
---
91+
92+
## Functional introduction of each version
6993

7094
- MagicEncoding4.0.0
7195
- Unicode encoding and decoding of character text.
@@ -90,7 +114,7 @@ This project is licensed under the GNU General Public License v3.0 - see the [LI
90114

91115
---
92116

93-
## **Renderings**
117+
## Main interface of each version
94118

95119
![MagicEncoding4.0.0_EN](https://www.notion.so/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2F4b165318-6383-451c-8845-110b786c9f0a%2Fbec5cc32-9058-45d2-baeb-3b24dfc55b96%2FMagicEncoding4.0.0_EN.png?table=block&id=100e64bd-e40f-8088-9b6a-ce06348c8739&t=100e64bd-e40f-8088-9b6a-ce06348c8739&width=1624&cache=v2)
96120

0 commit comments

Comments
 (0)