Updated docs.

aq-org · Dec 8, 2024 · 582828b · 582828b
1 parent 44849e6
commit 582828b
Show file tree

Hide file tree

Showing 6 changed files with 169 additions and 8 deletions.
diff --git a/docs/readme_ar.md b/docs/readme_ar.md
@@ -78,6 +78,9 @@
 
 <p align="center">قد تكون الترجمات غير دقيقة أو متأخرة، يرجى قراءة النسخة الإنجليزية إذا أمكنك ذلك. إذا وجدت أي أخطاء، يرجى إبلاغنا بها على<a href="https://github.com/aq-org/AQ/issues/new">إعداد التقارير</a>. </p>
 
+> [!CAUTION]
+> الترجمة قديمة، يُرجى مراجعة الوثائق الإنجليزية.
+
 ## الفهرس
 
 - [مقدمة](#مقدمة)

diff --git a/docs/readme_en.md b/docs/readme_en.md
@@ -11,9 +11,12 @@
      <a href="https://github.com/aq-org/AQ/commits">
        <img alt="Commits" src="https://img.shields.io/github/commit-activity/t/aq-org/AQ" />
      </a>
+<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Faq-org%2FAQ?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Faq-org%2FAQ.svg?type=shield"/></a>
      <a href="https://github.com/aq-org/AQ/pulse">
        <img alt="Created At" src="https://img.shields.io/github/created-at/aq-org/AQ" />
      </a>
+     </p>
+    <p align="center">
      <a href="https://github.com/aq-org/AQ/graphs/commit-activity">
        <img alt="Last Commits" src="https://img.shields.io/github/last-commit/aq-org/AQ" />
      </a>
@@ -26,6 +29,8 @@
      <a href="https://github.com/aq-org/AQ/issues">
        <img alt="Issues" src="https://img.shields.io/github/issues/aq-org/AQ" />
      </a>
+     </p>
+     <p align="center">
      <a href="https://github.com/aq-org/AQ/pulse">
        <img alt="Code Size" src="https://img.shields.io/github/languages/code-size/aq-org/AQ" />
      </a>
@@ -78,12 +83,20 @@
 
 <p align="center">Translations may be inaccurate or delayed, please read the English version if available. If you find any bugs, please <a href="https://github.com/aq-org/AQ/issues/new">report</a> to us. </p>
 
+## Our Sponsors
+<div align="center">
+<a href="https://opencollective.com/body-count" align="center"><img src="./docs/heymanbug.png"></img></a><br/>
+<a href="https://opencollective.com/body-count" align="center"><b>heymanbug</b></a>
+<b align="center">$200</b>
+</div>
+
 ## Table of contents
 
 - [Introduction](#introduce)
      - [Introduction](#introduction)
      - [Features](#features)
      - [Development progress](#development-progress)
+- [Detailed information](#detailed-information)
 - [Quick Start](#quickstart)
    - [Install](#install)
    - [usage](#usage)
@@ -96,7 +109,7 @@
 
 ### Introduction
 
-**AQ** is an `interpreted` **programming language**. It's `fast`, `small`, `simple` and `safe`. At the same time, programs written in AQ can also be compiled. *Perhaps a great work. *
+**AQ** is an `interpreted` **programming language**. It's `fast`, `small`, `simple` and `safe`. At the same time, programs written in AQ can also be compiled. *Perhaps a great work.*
 
 [![AQ Card](https://aq-org-github-readme-stats.vercel.app/api/pin/?username=aq-org&repo=AQ)](https://github.com/aq-org/AQ)
 
@@ -109,7 +122,7 @@
 - **Cross-platform** (supports `Windows`, `Linux` and `MacOS`, etc.)
 - Similar to `C++` syntax (quick mastery)
 - Interpreted (optional `compilation`)
-- Free (subject to `AQ License`)
+- Free (subject to `AGPL-3.0` or `AQ License`)
 - Open source (under `AQ license`)
 ### The following is a comparison between the **AQ** language and 15 other mainstream programming languages in different aspects:
 
@@ -152,9 +165,142 @@ Click to view development progress
 </a>
 </p>
 
+## Detailed information
+<table>
+<tr>
+<td><a href="https://app.fossa.com/projects/git%2Bgithub.com%2Faq-org%2FAQ?ref=badge_large" target="_blank" style="display: block" align="center">
+<img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Faq-org%2FAQ.svg?type=large" />
+</a></td>
+<td>
+<a href="https://next.ossinsight.io/widgets/official/compose-org-productivity-ratio?activity=pull-requests%2Fmerged&period=past_12_months&owner_id=158474695" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-productivity-ratio/thumbnail.png?activity=pull-requests%2Fmerged&period=past_12_months&owner_id=158474695&image_size=3x3&color_scheme=dark" width="273" height="auto">
+    <img alt="Pull-requests merged ratio of aq-org" src="https://next.ossinsight.io/widgets/official/compose-org-productivity-ratio/thumbnail.png?activity=pull-requests%2Fmerged&period=past_12_months&owner_id=158474695&image_size=3x3&color_scheme=light" width="273" height="auto">
+  </picture>
+</a></td>
+</tr>
+<tr>
+<td>
+<a href="https://next.ossinsight.io/widgets/official/compose-org-participants-roles-ratio?period=past_12_months&owner_id=158474695" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-participants-roles-ratio/thumbnail.png?period=past_12_months&owner_id=158474695&image_size=5x5&color_scheme=dark" width="465" height="auto">
+    <img alt="Participants roles of aq-org" src="https://next.ossinsight.io/widgets/official/compose-org-participants-roles-ratio/thumbnail.png?period=past_12_months&owner_id=158474695&image_size=5x5&color_scheme=light" width="465" height="auto">
+  </picture>
+</a></td>
+<td><a href="https://next.ossinsight.io/widgets/official/compose-org-participants-growth?activity=new&period=past_12_months&owner_id=158474695" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-participants-growth/thumbnail.png?activity=new&period=past_12_months&owner_id=158474695&image_size=4x7&color_scheme=dark" width="657" height="auto">
+    <img alt="New trends of aq-org" src="https://next.ossinsight.io/widgets/official/compose-org-participants-growth/thumbnail.png?activity=new&period=past_12_months&owner_id=158474695&image_size=4x7&color_scheme=light" width="657" height="auto">
+  </picture>
+</a></td>
+</tr>
+</table>
+
+<table>
+<tr>
+<td><a href="https://next.ossinsight.io/widgets/official/compose-org-code-changes-top-repositories?period=past_12_months&owner_id=158474695" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-code-changes-top-repositories/thumbnail.png?period=past_12_months&owner_id=158474695&image_size=3x6&color_scheme=dark" width="561" height="auto">
+    <img alt="Ranking of repos with the commit code changes in aq-org" src="https://next.ossinsight.io/widgets/official/compose-org-code-changes-top-repositories/thumbnail.png?period=past_12_months&owner_id=158474695&image_size=3x6&color_scheme=light" width="561" height="auto">
+  </picture>
+</a></td>
+<td><a href="https://next.ossinsight.io/widgets/official/compose-activity-trends?repo_id=751355154" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-activity-trends/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=dark" width="815" height="auto">
+    <img alt="Activity Trends of aq-org/AQ - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-activity-trends/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=light" width="815" height="auto">
+  </picture>
+</a></td>
+</tr>
+<tr>
+<td><a href="https://next.ossinsight.io/widgets/official/analyze-repo-pull-requests-size-per-month?repo_id=751355154" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-repo-pull-requests-size-per-month/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=dark" width="721" height="auto">
+    <img alt="Pull Request Size of aq-org/AQ" src="https://next.ossinsight.io/widgets/official/analyze-repo-pull-requests-size-per-month/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=light" width="721" height="auto">
+  </picture>
+</a></td>
+<td><a href="https://next.ossinsight.io/widgets/official/analyze-repo-loc-per-month?repo_id=751355154" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-repo-loc-per-month/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=dark" width="721" height="auto">
+    <img alt="Lines of Code Changes of aq-org/AQ" src="https://next.ossinsight.io/widgets/official/analyze-repo-loc-per-month/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=light" width="721" height="auto">
+  </picture>
+</a></td>
+</tr>
+</table>
+
+<table>
+<tr>
+<td><a href="https://next.ossinsight.io/widgets/official/analyze-org-commits-time-distribution?period=past_12_months&zone=0&owner_id=158474695" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-org-commits-time-distribution/thumbnail.png?period=past_12_months&zone=0&owner_id=158474695&image_size=3x6&color_scheme=dark" width="561" height="auto">
+    <img alt="When Do Participants Prefer to Submit Code?" src="https://next.ossinsight.io/widgets/official/analyze-org-commits-time-distribution/thumbnail.png?period=past_12_months&zone=0&owner_id=158474695&image_size=3x6&color_scheme=light" width="561" height="auto">
+  </picture>
+</a></td>
+<td><a href="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats?repo_id=751355154" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=dark" width="655" height="auto">
+    <img alt="Performance Stats of aq-org/AQ - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=light" width="655" height="auto">
+  </picture>
+</a></td>
+</tr>
+<tr>
+<td><a href="https://next.ossinsight.io/widgets/official/analyze-repo-pushes-and-commits-per-month?repo_id=751355154" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-repo-pushes-and-commits-per-month/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=dark" width="721" height="auto">
+    <img alt="Pushes and Commits of aq-org/AQ" src="https://next.ossinsight.io/widgets/official/analyze-repo-pushes-and-commits-per-month/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=light" width="721" height="auto">
+  </picture>
+</a></td>
+<td><a href="https://next.ossinsight.io/widgets/official/analyze-repo-stars-map?activity=stars&repo_id=751355154" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-repo-stars-map/thumbnail.png?activity=stars&repo_id=751355154&image_size=auto&color_scheme=dark" width="721" height="auto">
+    <img alt="Star Geographical Distribution of aq-org/AQ" src="https://next.ossinsight.io/widgets/official/analyze-repo-stars-map/thumbnail.png?activity=stars&repo_id=751355154&image_size=auto&color_scheme=light" width="721" height="auto">
+  </picture>
+</a></td>
+</tr>
+</table>
+
+<table>
+<tr>
+<td><a href="https://next.ossinsight.io/widgets/official/analyze-repo-pull-requests-size-per-month?repo_id=751355154" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-repo-pull-requests-size-per-month/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=dark" width="721" height="auto">
+    <img alt="Pull Request Size of aq-org/AQ" src="https://next.ossinsight.io/widgets/official/analyze-repo-pull-requests-size-per-month/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=light" width="721" height="auto">
+  </picture>
+</a></td>
+<td><a href="https://next.ossinsight.io/widgets/official/analyze-repo-pull-request-open-to-merged?repo_id=751355154" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-repo-pull-request-open-to-merged/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=dark" width="721" height="auto">
+    <img alt="Pull Request Lifecycle of aq-org/AQ" src="https://next.ossinsight.io/widgets/official/analyze-repo-pull-request-open-to-merged/thumbnail.png?repo_id=751355154&image_size=auto&color_scheme=light" width="721" height="auto">
+  </picture>
+</a></td>
+</tr>
+<tr>
+<td><a href="https://next.ossinsight.io/widgets/official/analyze-repo-commits-time-distribution?period=all_times&zone=0&repo_id=751355154" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-repo-commits-time-distribution/thumbnail.png?period=all_times&zone=0&repo_id=751355154&image_size=auto&color_scheme=dark" width="721" height="auto">
+    <img alt="Commits Time Distribution of aq-org/AQ" src="https://next.ossinsight.io/widgets/official/analyze-repo-commits-time-distribution/thumbnail.png?period=all_times&zone=0&repo_id=751355154&image_size=auto&color_scheme=light" width="721" height="auto">
+  </picture>
+</a></td>
+<td>
+<a href="https://next.ossinsight.io/widgets/official/analyze-org-activity-efficiency?period=past_12_months&activity=pull-requests&owner_id=158474695" target="_blank" style="display: block" align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-org-activity-efficiency/thumbnail.png?period=past_12_months&activity=pull-requests&owner_id=158474695&image_size=3x9&color_scheme=dark" width="849" height="auto">
+    <img alt="Count of Pull requests Over Time" src="https://next.ossinsight.io/widgets/official/analyze-org-activity-efficiency/thumbnail.png?period=past_12_months&activity=pull-requests&owner_id=158474695&image_size=3x9&color_scheme=light" width="849" height="auto">
+  </picture>
+</a>
+</td>
+</tr>
+</table>
+
+
+
+<!-- Made with [OSS Insight](https://ossinsight.io/) -->
+
 ## Quick Start
 ### Install
 
+> [!NOTE]  
+> The AQ program is not yet fully developed and some features may not be available.
+
 **AQ** can be installed in `multiple ways`, including `source code compilation` and `precompiled binaries`. The specific installation steps vary by platform, please check the [Installation Guide](docs/installation.md) for more information.
 
 On platforms such as `Linux`, you can compile like this:
@@ -198,15 +344,15 @@ AQ is an open source project and everyone is welcome to contribute to it! Whethe
 
 ## License
 
-**AQ** is based on [AQ License](https://github.com/aq-org/AQ/blob/main/LICENSE). This is a `license` designed specifically for **AQ** to protect **AQ**'s `intellectual property` and `community interests`.
+**AQ** is based on `AGPL-3.0` or [AQ License](https://github.com/aq-org/AQ/blob/main/aq-license.txt). This is a `license` designed specifically for **AQ** to protect **AQ**'s `intellectual property` and `community interests`.
 
-The `AQ License` allows you to `freely use`, `modify` and `distribute` **AQ** under the conditions of the license, but it also has some restrictions on your actions. For example, you need to retain **AQ**'s `copyright statement` and `license text` and not use them for illegal or unethical purposes.
+The `AGPL-3.0` or `AQ License` allows you to `freely use`, `modify` and `distribute` **AQ** under the conditions of the license, but it also has some restrictions on your actions. For example, you need to retain **AQ**'s `copyright statement` and `license text` and not use them for illegal or unethical purposes.
 
-If you plan to use **AQ** for `commercial use`, or develop `derivative products` based on **AQ**, please read the full text of the `AQ License` carefully and abide by the `terms and conditions` therein. If you have any questions, you can also contact us at any time.
+If you plan to use **AQ** for `commercial use`, or develop `derivative products` based on **AQ**, please read the full text of the `AGPL-3.0` or `AQ License` carefully and abide by the `terms and conditions` therein. If you have any questions, you can also contact us at any time.
 
 In addition, **AQ** itself may also use "parts of code" from other "open source software", and these codes may be subject to "other licenses". We will accurately mark these `license information` in the code.
 
-We believe that the `AQ License` can well balance **AQ**'s `open source` and `intellectual property protection`, creating favorable conditions for **AQ**'s `long-term development`. If you have any questions or suggestions about the license, please feel free to discuss it with us.
+We believe that the `AGPL-3.0` or `AQ License` can well balance **AQ**'s `open source` and `intellectual property protection`, creating favorable conditions for **AQ**'s `long-term development`. If you have any questions or suggestions about the license, please feel free to discuss it with us.
 
 > Copyright 2024 AQ author, All Rights Reserved.
-> This program is licensed under the AQ License. You can find the AQ license in the root directory.
+> This program is licensed under the AGPL-3.0 or AQ License. You can find the AQ license in the root directory.
diff --git a/docs/readme_es.md b/docs/readme_es.md
@@ -78,7 +78,10 @@
 
 <p align="center">Las traducciones pueden ser inexactas o retrasadas; lea la versión en inglés si puede. Si encuentra algún error, por favor infórmenos<a href="https://github.com/aq-org/AQ/issues/new"> Informe</a>。</p>
 
-## 目录
+> [!CAUTION]
+> La traducción no está actualizada, consulte la documentación en inglés.
+
+## directorio
 
 - [introducir](#introducir)
     - [Introducción](#introducción)

diff --git a/docs/readme_fr.md b/docs/readme_fr.md
@@ -78,6 +78,9 @@
 
 <p align="center">Les traductions peuvent être inexactes ou retardées, veuillez lire la version anglaise si vous le pouvez. Si vous trouvez des erreurs, merci de nous les signaler<a href="https://github.com/aq-org/AQ/issues/new">Rapport</a>。</p>
 
+> [!CAUTION]
+> La traduction est obsolète, veuillez consulter la documentation en anglais.
+
 ## Table des matières
 
 - [introduire](#introduire)

diff --git a/docs/readme_ru.md b/docs/readme_ru.md
@@ -78,6 +78,9 @@
 
 <p align="center">Переводы могут быть неточными или задерживаться. Пожалуйста, прочитайте английскую версию, если она доступна. Если вы обнаружите какие-либо ошибки, <a href="https://github.com/aq-org/AQ/issues/new">сообщите нам</a>. </p>
 
+> [!CAUTION]
+> Перевод устарел, пожалуйста, проверьте документацию на английском языке.
+
 ## Оглавление
 
 - [представлять](#представлять)

diff --git a/docs/readme_zh.md b/docs/readme_zh.md
@@ -78,6 +78,9 @@
 
 <p align="center">翻译可能不准确或延迟，如果可以，请阅读英文版本。如果你发现任何错误，请向我们<a href="https://github.com/aq-org/AQ/issues/new">报告</a>。</p>
 
+> [!CAUTION]
+> 翻译已经过时，请查看英文文档。
+
 ## 目录
 
 - [介绍](#介绍)