Skip to content

Commit

Permalink
Doc: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
BLKSerene committed Jan 28, 2025
1 parent d719fd8 commit f554838
Show file tree
Hide file tree
Showing 10 changed files with 53 additions and 47 deletions.
2 changes: 1 addition & 1 deletion ACKS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<div align="center"><h1>Acknowledgments</h1></div>

As Wordless stands on the shoulders of giants, I hereby extend my sincere gratitude to the following open-source projects without which this project would not have been possible:
As *Wordless* stands on the shoulders of giants, I hereby extend my sincere gratitude to the following open-source projects without which this project would not have been possible:

&nbsp;|Name|Version|Authors|License
-----:|----|:-----:|-------|:-----:
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# --------------------------------------------------------------------->

If you would like to contribute to the development of Wordless, you can help with bug fixes, performance enhancements, or implementation of new features by submitting [pull requests](https://github.com/BLKSerene/Wordless/pulls) on Github.
If you would like to contribute to the development of *Wordless*, you can help with bug fixes, performance enhancements, or implementation of new features by submitting [pull requests](https://github.com/BLKSerene/Wordless/pulls) on GitHub.

Besides, you may contribute by writing [wikis](https://github.com/BLKSerene/Wordless/wiki) on Github, making tutorial videos, or helping with the translation of the user interface and [documentation](/doc/doc_eng.md) into other languages.
Besides, you may contribute by writing [wikis](https://github.com/BLKSerene/Wordless/wiki) on GitHub, making tutorial videos, or helping with the translation of the user interface and [documentation](/doc/doc_eng.md) into other languages.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<a href="https://dl.circleci.com/status-badge/redirect/gh/BLKSerene/Wordless/tree/main">
<img src="https://dl.circleci.com/status-badge/img/gh/BLKSerene/Wordless/tree/main.svg?style=svg" alt="CircleCI"></a>
<a href="https://github.com/BLKSerene/Wordless/actions/workflows/tests.yml">
<img src="https://github.com/BLKSerene/Wordless/actions/workflows/tests.yml/badge.svg" alt="Github Actions"></a>
<img src="https://github.com/BLKSerene/Wordless/actions/workflows/tests.yml/badge.svg" alt="GitHub Actions"></a>
<a href="https://codecov.io/gh/BLKSerene/Wordless">
<img src="https://codecov.io/gh/BLKSerene/Wordless/branch/main/graph/badge.svg?token=ED6TW92A7G" alt="Codecov"></a>
</div>
Expand Down Expand Up @@ -67,11 +67,13 @@

<br>

Wordless is an integrated corpus tool with multilingual support for the study of language, literature, and translation designed and developed since 2018 by Ye Lei (叶磊), then MA student in interpreting studies at Shanghai International Studies University (上海外国语大学).
*Wordless* is an integrated corpus tool with multilingual support for the study of language, literature, and translation designed and developed by Ye Lei (叶磊), then MA student in interpreting studies at Shanghai International Studies University, Shanghai, China since 2018.

Recipient of [the best paper prize of the 3rd Vorobyovy Gory International Forum of Young Students and Scholars (VGIF-2024)](https://mp.weixin.qq.com/s/nVcIeZHgKG0eFbyv1Ux3iw)

## Download

The latest version (**3.5.0**) of Wordless supports **Windows 7/8/8.1/10/11**, **macOS 10.11 or later**, **Ubuntu 18.04 or later**, **Debian 10 or later**, and **Arch Linux**, all **64-bit only**. Both Intel-based and Apple Silicon-based Macs are supported.
The latest version (**3.5.0**) of *Wordless* supports **Windows 7/8/8.1/10/11**, **macOS 10.11 or later**, **Ubuntu 18.04 or later**, **Debian 10 or later**, and **Arch Linux**, all **64-bit only**. Both Intel-based and Apple Silicon-based Macs are supported.

For a detailed changelog, please see [CHANGELOG.md](/CHANGELOG.md).

Expand All @@ -81,20 +83,20 @@ Release|Remarks
[Latest Release for macOS](https://github.com/BLKSerene/Wordless/releases/download/3.5.0/wordless_3.5.0_macos.zip)|1. Extract all files<br>2. Double-click **Wordless.app** to run
[Latest Release for Linux](https://github.com/BLKSerene/Wordless/releases/download/3.5.0/wordless_3.5.0_linux.tar.gz)|1. Extract all files<br>2. Double-click **Wordless/Wordless** to run<br>3. [Optional] Double-click **Wordless/Wordless - Create Shortucut** to create a shortcut in **Show Applications**
[Past Releases](https://github.com/BLKSerene/Wordless/releases)|Not recommended
[Baidu Netdisk](https://pan.baidu.com/s/1--ZzABrDQBZlZagWlVQMbg?pwd=wdls#list/path=%2FWordless%2FWordless%203.5.0&parentPath=%2F)|For Chinese users with unstable connections to Github (**PASSWORD: wdls**)
[Baidu Netdisk](https://pan.baidu.com/s/1--ZzABrDQBZlZagWlVQMbg?pwd=wdls#list/path=%2FWordless%2FWordless%203.5.0&parentPath=%2F)|For Chinese users with unstable connections to GitHub (**PASSWORD: wdls**)

> [!IMPORTANT]
> **Note 1:** It is recommended that the path to Wordless **not contain any non-ASCII chatacters, such as Chinese characters and letters with diacritics**.
> **Note 1:** It is recommended that the path to *Wordless* **not contain any non-ASCII chatacters, such as Chinese characters and letters with diacritics**.
>
> **Note 2:** If your Mac says that **“Wordless” is damaged and can’t be opened**, please open **Terminal** (Launchpad → Other) and run:
>
> <code>xattr -rc /Applications/Wordless.app</code><br>
>
> remember to replace **/Applications/Wordless.app** with the actual path of Wordless on your computer (you could drag **Wordless.app** to the **Terminal**). Then, **run Wordless again** (the warning prompted in Terminal could be ignored if the program could be successfully opened).
> remember to replace **/Applications/Wordless.app** with the actual path of *Wordless* on your computer (you could drag **Wordless.app** to the **Terminal**). Then, **run *Wordless* again** (the warning prompted in Terminal could be ignored if the program could be successfully opened).
>
> **Note 3:** While opening corpora in languages other than English in *Wordless*, extra model files might need to be downloaded from the internet. If you encounter a **Network Error** dialog while downloading the model, chances are that it's a literal network error, so you just need to check your internet connections following the instructions in the error message and try downloading the model once more.
>
> Users in China, where connections to Github and Hugging Face Hub are unstable, are recommended to use a proxy and set properly the settings in **Menu Bar → Preferences → Settings → General → Proxy Settings**. Alternatively, Chinese users can choose to manually download model files from [Baidu Netdisk](https://pan.baidu.com/s/1--ZzABrDQBZlZagWlVQMbg?pwd=wdls#list/path=%2FWordless%2Fmodels&parentPath=%2F). The steps of installing models are as follows:
> Users in China, where connections to GitHub and Hugging Face Hub are unstable, are recommended to use a proxy and set properly the settings in **Menu Bar → Preferences → Settings → General → Proxy Settings**. Alternatively, Chinese users can choose to manually download model files from [Baidu Netdisk](https://pan.baidu.com/s/1--ZzABrDQBZlZagWlVQMbg?pwd=wdls#list/path=%2FWordless%2Fmodels&parentPath=%2F). The steps of installing models are as follows:
>
> 1. Check the error message displayed in the **Network Error** dialog. If **stanza** is found in the error message, you need a *Stanza* model, otherwise you need a *spaCy* model.
> 2. Download model files for the language of your corpus from the above link and **extract all files**.
Expand All @@ -112,8 +114,8 @@ Support Channel |Information
----------------------|-----------
Official documentation|[Stable Version](https://github.com/BLKSerene/Wordless/blob/3.5.0/doc/doc.md) \| [Development Version](/doc/doc.md)
Tutorial videos |[YouTube](https://www.youtube.com/@BLKSerene) \| [bilibili](https://space.bilibili.com/34963752/video)
Bug reports |[Github Issues](https://github.com/BLKSerene/Wordless/issues)
Usage questions |[Github Discussions](https://github.com/BLKSerene/Wordless/discussions)
Bug reports |[GitHub Issues](https://github.com/BLKSerene/Wordless/issues)
Usage questions |[GitHub Discussions](https://github.com/BLKSerene/Wordless/discussions)
Email support |[blkserene<i>@</i>gmail<i>.</i>com](mailto:[email protected])
[WeChat](https://www.wechat.com/en/) official account|![WeChat official account](/imgs/wechat_official_account.jpg)

Expand All @@ -135,13 +137,13 @@ MLA (9th edition):
2. Cite as a piece of computer software

APA (7th edition):
<pre><code>Ye, L. (2024). <i>Wordless</i> (Version 3.5.0) [Computer software]. Github. https://github.com/BLKSerene/Wordless</code></pre>
<pre><code>Ye, L. (2024). <i>Wordless</i> (Version 3.5.0) [Computer software]. GitHub. https://github.com/BLKSerene/Wordless</code></pre>

Chicago (18th edition):
<pre><code>Ye, Lei. <i>Wordless</i>. V. 3.5.0. Released July 1, 2024. PC. https://github.com/BLKSerene/Wordless.</code></pre>

MLA (9th edition):
<pre><code>Ye Lei. <i>Wordless</i>. Version 3.5.0, <i>Github</i>, 1 Jul. 2024, https://github.com/BLKSerene/Wordless.</code></pre>
<pre><code>Ye Lei. <i>Wordless</i>. Version 3.5.0, <i>GitHub</i>, 1 Jul. 2024, https://github.com/BLKSerene/Wordless.</code></pre>

## Works Using *Wordless*
For details, please click [HERE](/WORKS_USING_WORDLESS.md).
Expand Down Expand Up @@ -171,7 +173,7 @@ For details, please click [HERE](/CONTRIBUTING.md).

## Donating

If you would like to support the development of Wordless, you may donate via [PayPal](https://www.paypal.com/), [Alipay](https://global.alipay.com/), or [WeChat Pay](https://pay.weixin.qq.com/index.php/public/wechatpay_en).
If you would like to support the development of *Wordless*, you may donate via [PayPal](https://www.paypal.com/), [Alipay](https://global.alipay.com/), or [WeChat Pay](https://pay.weixin.qq.com/index.php/public/wechatpay_en).

PayPal|Alipay|WeChat Pay
------|------|----------
Expand Down
2 changes: 1 addition & 1 deletion doc/trs/zho_cn/ACKS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<div align="center"><h1>致谢</h1></div>

鉴于 Wordless 立于巨人的肩膀之上,我谨在此向下列开源项目致以本人诚挚的感谢,若没有它们,本项目将无法完成:
鉴于 *Wordless* 立于巨人的肩膀之上,我谨在此向下列开源项目致以本人诚挚的感谢,若没有它们,本项目将无法完成:

&nbsp;|名称|版本|作者|许可
-----:|----|:-----:|-------|:-----:
Expand Down
4 changes: 2 additions & 2 deletions doc/trs/zho_cn/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# --------------------------------------------------------------------->

如果你有意助力 Wordless 的开发工作,你可以在 Github 上提交 [pull requests](https://github.com/BLKSerene/Wordless/pulls) 来帮助修复程序错误、改善性能或实现新功能。
如果你有意助力 *Wordless* 的开发工作,你可以在 GitHub 上提交 [pull requests](https://github.com/BLKSerene/Wordless/pulls) 来帮助修复程序错误、改善性能或实现新功能。

此外,你还可以在 Github 上撰写[百科](https://github.com/BLKSerene/Wordless/wiki)、制作视频教程、或帮助将用户界面及[文档](/doc/doc_eng.md)翻译为其他语言。
此外,你还可以在 GitHub 上撰写[百科](https://github.com/BLKSerene/Wordless/wiki)、制作视频教程、或帮助将用户界面及[文档](/doc/doc_eng.md)翻译为其他语言。
26 changes: 14 additions & 12 deletions doc/trs/zho_cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<a href="https://dl.circleci.com/status-badge/redirect/gh/BLKSerene/Wordless/tree/main">
<img src="https://dl.circleci.com/status-badge/img/gh/BLKSerene/Wordless/tree/main.svg?style=svg" alt="CircleCI"></a>
<a href="https://github.com/BLKSerene/Wordless/actions/workflows/tests.yml">
<img src="https://github.com/BLKSerene/Wordless/actions/workflows/tests.yml/badge.svg" alt="Github Actions"></a>
<img src="https://github.com/BLKSerene/Wordless/actions/workflows/tests.yml/badge.svg" alt="GitHub Actions"></a>
<a href="https://codecov.io/gh/BLKSerene/Wordless">
<img src="https://codecov.io/gh/BLKSerene/Wordless/branch/main/graph/badge.svg?token=ED6TW92A7G" alt="Codecov"></a>
</div>
Expand Down Expand Up @@ -67,11 +67,13 @@

<br>

Wordless 是一款具有多语种支持的语料库集成工具,可用于语言、文学及翻译研究,由当时就读于上海外国语大学口译研究专业的硕士研究生叶磊自2018年起设计和开发。
*Wordless* 是一款具有多语种支持的语料库集成工具,可用于语言、文学及翻译研究,由当时就读于上海外国语大学口译研究专业的硕士研究生叶磊自2018年起设计并开发。

荣获[第三届麻雀山国际青年学生学者论坛优秀论文奖](https://mp.weixin.qq.com/s/nVcIeZHgKG0eFbyv1Ux3iw)

## 下载

Wordless 最新版(**3.5.0**)支持 **Windows 7/8/8.1/10/11****macOS 10.11 或更高版本****Ubuntu 18.04 或更高版本****Debian 10 或更高版本**以及**Arch Linux**,均仅支持**64位操作系统**。英特尔和 Apple 芯片的苹果电脑均有支持。
最新版 *Wordless***3.5.0**)支持 **Windows 7/8/8.1/10/11****macOS 10.11 或更高版本****Ubuntu 18.04 或更高版本****Debian 10 或更高版本**以及 **Arch Linux**,均仅支持**64位操作系统**。英特尔和 Apple 芯片的苹果电脑均有支持。

如需完整的更新日志,请参阅 [CHANGELOG.md](/CHANGELOG.md)(待翻译)。

Expand All @@ -81,20 +83,20 @@ Wordless 最新版(**3.5.0**)支持 **Windows 7/8/8.1/10/11**、**macOS 10.1
[macOS 最新版](https://github.com/BLKSerene/Wordless/releases/download/3.5.0/wordless_3.5.0_macos.zip)|1. 解压缩所有文件<br>2. 双击运行 **Wordless.app**
[Linux 最新版](https://github.com/BLKSerene/Wordless/releases/download/3.5.0/wordless_3.5.0_linux.tar.gz)|1. 解压缩所有文件<br>2. 双击运行 **Wordless/Wordless**<br>3. [可选] 双击 **Wordless/Wordless - Create Shortucut****显示应用程序**中创建一个快捷方式
[历史版本](https://github.com/BLKSerene/Wordless/releases)|不推荐
[百度网盘](https://pan.baidu.com/s/1--ZzABrDQBZlZagWlVQMbg?pwd=wdls#list/path=%2FWordless%2FWordless%203.5.0&parentPath=%2F)|中国用户若 Github 连接不稳定可尝试该下载链接(**提取码:wdls**
[百度网盘](https://pan.baidu.com/s/1--ZzABrDQBZlZagWlVQMbg?pwd=wdls#list/path=%2FWordless%2FWordless%203.5.0&parentPath=%2F)|国内用户若 GitHub 连接不稳定可尝试该下载链接(**提取码:wdls**

> [!IMPORTANT]
> **备注 1:**Wordless 的路径中**不建议包含任何非 ASCII 字符,如汉字和带变音记号的字母等**
> **备注 1:***Wordless* 的路径中**不建议包含任何非 ASCII 字符,如汉字和带变音记号的字母等**
>
> **备注 2:**苹果电脑用户如遇提示 **“Wordless”已损坏,无法打开**,请打开**终端**(启动台 → 其他)后运行:
>
> <code>xattr -rc /Applications/Wordless.app</code><br>
>
> 请注意将 **/Applications/Wordless.app** 替换为 Wordless 在电脑上的实际存放路径(可直接拖拽 **Wordless.app** 文件至**终端**中)。然后,**再次运行 Wordless**(若程序可成功运行,终端中提示的警告可忽略)。
> 请注意将 **/Applications/Wordless.app** 替换为 *Wordless* 在电脑上的实际存放路径(可直接拖拽 **Wordless.app** 文件至**终端**中)。然后,**再次运行 *Wordless***(若程序可成功运行,终端中提示的警告可忽略)。
>
> **备注 3:***Wordless* 中打开除英语外语种的语料库时,可能需要从网上下载额外的模型文件。如果出现**网络错误**对话框,那么大概率是字面意义上的网络错误,所以只需要按照错误信息中的指示检查网络连接,然后再次尝试下载模型即可。
>
> 中国国内和 Github 以及 Hugging Face Hub 的连接不稳定,因此建议用户使用代理并在**菜单栏 → 偏好 → 设置 → 全局 → 代理设置**处进行设置。或者也可以手动从[百度网盘](https://pan.baidu.com/s/1--ZzABrDQBZlZagWlVQMbg?pwd=wdls#list/path=%2FWordless%2Fmodels&parentPath=%2F)下载模型文件。模型的安装步骤如下:
> 国内与 GitHub 以及 Hugging Face Hub 的连接不稳定,因此建议用户使用代理并在**菜单栏 → 偏好 → 设置 → 全局 → 代理设置**处进行设置。或者也可以手动从[百度网盘](https://pan.baidu.com/s/1--ZzABrDQBZlZagWlVQMbg?pwd=wdls#list/path=%2FWordless%2Fmodels&parentPath=%2F)下载模型文件。模型的安装步骤如下:
>
> 1. 查看**网络错误**对话框中的错误信息。如果错误信息中能找到 **stanza** 的字样,那么你需要的是 *Stanza* 模型,否则你需要的是 *spaCy* 模型。
> 2. 从上方链接中下载你的语料库语种所对应的模型文件然后**将所有文件解压出来**
Expand All @@ -112,8 +114,8 @@ Wordless 最新版(**3.5.0**)支持 **Windows 7/8/8.1/10/11**、**macOS 10.1
-------|----
官方文档|[稳定版](https://github.com/BLKSerene/Wordless/blob/3.5.0/doc/doc.md) \| [开发版](/doc/doc.md)
视频教程|[YouTube](https://www.youtube.com/@BLKSerene) \| [B站](https://space.bilibili.com/34963752/video)
Bug 提交|[Github Issues](https://github.com/BLKSerene/Wordless/issues)
使用疑问|[Github Discussions](https://github.com/BLKSerene/Wordless/discussions)
Bug 提交|[GitHub Issues](https://github.com/BLKSerene/Wordless/issues)
使用疑问|[GitHub Discussions](https://github.com/BLKSerene/Wordless/discussions)
邮件咨询|[blkserene<i>@</i>gmail<i>.</i>com](mailto:[email protected])
[微信](https://weixin.qq.com/)公众号|![微信公众号](/imgs/wechat_official_account.jpg)

Expand All @@ -135,13 +137,13 @@ MLA(第 9 版):
2. 根据计算机软件的格式进行引用

APA(第 7 版):
<pre><code>Ye, L. (2024). <i>Wordless</i> (Version 3.5.0) [Computer software]. Github. https://github.com/BLKSerene/Wordless</code></pre>
<pre><code>Ye, L. (2024). <i>Wordless</i> (Version 3.5.0) [Computer software]. GitHub. https://github.com/BLKSerene/Wordless</code></pre>

Chicago(第 18 版):
<pre><code>Ye, Lei. <i>Wordless</i>. V. 3.5.0. Released July 1, 2024. PC. https://github.com/BLKSerene/Wordless.</code></pre>

MLA(第 9 版):
<pre><code>Ye Lei. <i>Wordless</i>. Version 3.5.0, <i>Github</i>, 1 Jul. 2024, https://github.com/BLKSerene/Wordless.</code></pre>
<pre><code>Ye Lei. <i>Wordless</i>. Version 3.5.0, <i>GitHub</i>, 1 Jul. 2024, https://github.com/BLKSerene/Wordless.</code></pre>

## 使用 *Wordless* 的成果

Expand Down Expand Up @@ -172,7 +174,7 @@ MLA(第 9 版):

## 赞助

如果你愿意支持 Wordless 的开发工作,你可以通过 [PayPal](https://www.paypal.com/)[支付宝](https://www.alipay.com/)[微信支付](https://pay.weixin.qq.com/)进行赞助。
如果你愿意支持 *Wordless* 的开发工作,你可以通过 [PayPal](https://www.paypal.com/)[支付宝](https://www.alipay.com/)[微信支付](https://pay.weixin.qq.com/)进行赞助。

PayPal|支付宝|微信支付
------|-----|--------
Expand Down
2 changes: 1 addition & 1 deletion doc/trs/zho_tw/ACKS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<div align="center"><h1>致謝</h1></div>

鑑於 Wordless 立於巨人的肩膀之上,我謹在此向下列開源專案致以本人誠摯的感謝,若沒有它們,本專案將無法完成:
鑑於 *Wordless* 立於巨人的肩膀之上,我謹在此向下列開源專案致以本人誠摯的感謝,若沒有它們,本專案將無法完成:

&nbsp;|名稱|版本|作者|許可
-----:|----|:-----:|-------|:-----:
Expand Down
Loading

0 comments on commit f554838

Please sign in to comment.