Updated docs.

aq-org · Dec 1, 2024 · a3a613f · a3a613f
1 parent 6b2d214
commit a3a613f
Show file tree

Hide file tree

Showing 2 changed files with 164 additions and 9 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -78,6 +78,13 @@
 
 <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)
@@ -96,7 +103,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 +116,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` and `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:
 
@@ -198,15 +205,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` and [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` and `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` and `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` and `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 and AQ License. You can find the AQ license in the root directory.
diff --git a/docs/index.md b/docs/index.md
@@ -60,12 +60,160 @@
      ·
      <a href="https://github.com/aq-org/AQ/discussions/new/choose">Request to add features</a>
    </p>
+   <p align="center">
+     <a href="/docs/readme_ar.md">عربي</a>
+     ·
+     <a href="/docs/readme_zh.md">简体中文</a>
+     ·
+     <a href="/docs/readme_en.md">English</a>
+     ·
+     <a href="/docs/readme_fr.md">Français</a>
+     ·
+     <a href="/docs/readme_ru.md">Русский</a>
+     ·
+     <a href="/docs/readme_es.md">Española</a>
+   </p>
 
 <p align="center">Like this project? Please consider <a href="https://github.com/aq-org/AQ">Sponsor</a>, <a href="https://github.com/aq-org/AQ">join development </a> or <a href="https://github.com/aq-org/AQ">Stars</a> to help it improve! </p>
 
 <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>
 
-### Go to https://aq-org.github.io
+## 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)
+- [Quick Start](#quickstart)
+   - [Install](#install)
+   - [usage](#usage)
+- [Documentation](#documentation)
+- [Language Standard](#language-standard)
+- [Contributors](#contributors)
+- [LICENSE](#license)
+
+## Introduce
+
+### 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 Card](https://aq-org-github-readme-stats.vercel.app/api/pin/?username=aq-org&repo=AQ)](https://github.com/aq-org/AQ)
+
+### Features
+
+- **Fast** (`source code` compilation and `running speed`)
+- **Small** (`source code` size)
+- **Simple** (easy to learn)
+- **Security** (safe `memory management` and `code inspection`)
+- **Cross-platform** (supports `Windows`, `Linux` and `MacOS`, etc.)
+- Similar to `C++` syntax (quick mastery)
+- Interpreted (optional `compilation`)
+- Free (subject to `AGPL-3.0` and `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:
+
+| Language | Types | Speed | Size | Simplicity | Security | Cross-platform | Syntax style | Execution | Open source | Application areas |
+| ------ | ------ | ------ | ------ | -------- | -------- | --------- | ----------- | ----------- | ------- | ----------- |
+| AQ | Interpreted/Compiled | ★★★★ | ★★★★★ | ★★★★★ | ★★★★★ | ★★★★★ | Object-oriented/Procedural | Interpreted/Compiled | √ | General |
+| C | Compiled | ★★★★★ | ★★★★ | ★★ | ★★★ | ★★★★ | Procedural | Compiled | √ | System/Underlying |
+| C++ | Compiled | ★★★★★ | ★★★★ | ★★★ | ★★★ | ★★★★ | Object-oriented | Compiled | √ | Universal |
+| Java | Interpreted/Compiled | ★★★★ | ★★★ | ★★★★ | ★★★★★ | ★★★★★ | Object-oriented | Interpreted/Compiled | √ | Universal |
+| Python | Interpreted | ★★★ | ★★★★★ | ★★★★★ | ★★★★ | ★★★★★ | Object-oriented | Interpreted | √ | Universal |
+| JavaScript | Interpreted | ★★★★ | ★★★★★ | ★★★★ | ★★★ | ★★★★★ | Object-oriented | Interpreted | √ | Web/Server |
+| Go | Compiled | ★★★★★ | ★★★★ | ★★★★ | ★★★★ | ★★★★★ | Procedural | Compiled | √ | System/Network |
+| Ruby | Interpreted | ★★★ | ★★★★ | ★★★★★ | ★★★★ | ★★★★★ | Object-oriented | Interpreted | √ | Web Development |
+| Swift | Compiled | ★★★★★ | ★★★★ | ★★★★ | ★★★★★ | ★★★ | Object-oriented | Compiled | √ | Mobile development |
+| Rust | Compiled | ★★★★★ | ★★★★★ | ★★★ | ★★★★★ | ★★★★★ | Object-oriented | Compiled | √ | System/Web |
+| Kotlin | Compiled | ★★★★ | ★★★★ | ★★★★ | ★★★★★ | ★★★★★ | Object-oriented | Compiled | √ | Mobile/Server |
+| Scala | Compiled | ★★★★ | ★★★ | ★★★ | ★★★★ | ★★★★★ | Functional | Compiled | √ | Big Data/Web |
+| R | Interpretation | ★★ | ★★★★★ | ★★★★ | ★★★★ | ★★★★ | Matrix | Interpretation | √ | Statistics/Data Analysis |
+| Perl | Interpreted | ★★★ | ★★★★ | ★★★ | ★★★ | ★★★★★ | Procedural | Interpreted | √ | Text Processing/Web |
+| PHP | Interpreted | ★★★ | ★★★★★ | ★★★★★ | ★★★ | ★★★★★ | Object-oriented | Interpreted | √ | Web Development |
+
+Notice:
+1. The number of stars represents the degree of excellence in this aspect (maximum 5 stars).
+2. This is only a rough comparison, and the actual situation may be different.
+3. The open source mark (√) indicates that the language itself is open source.
+
+As can be seen from the table, the **AQ** language has better performance in terms of speed, size, simplicity, security and cross-platformness. Its syntax style is similar to `C++`, it can be interpreted and executed or compiled and executed, and it is completely open source. AQ aims to be a general-purpose programming language suitable for various application scenarios. Compared with other languages, its advantage is that it has both high performance and ease of use.
+
+### Development progress
+
+**AQ** is currently under active development and has implemented basic `syntax` and `functions`. But there is still a lot of work to be done, including optimizing performance, adding library support and improving development tools. We welcome everyone to join the development and contribute to **AQ**!
+
+<p align="center">
+   <img src="https://github-readme-stats.vercel.app/api/pin/?username=aq-org&repo=AQ" alt="GitHub Stats" >
+</p>
+
+<p align="center">
+<a href="https://github.com/aq-org/AQ/commits">
+Click to view development progress
+</a>
+</p>
+
+## Quick Start
+### Install
+
+**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:
+```shell
+mkdir build
+cd build
+cmake ..
+make
+```
+
+On `Windows`, you need to download `CMake` and other necessary tools first, and then `compile`.
+
+Finally, you can run on `Linux` and `Windows`:
+```shell
+cd aq
+
+# Find an executable file like aq or aq.exe and run it
+```
+
+### Usage
+You can run **AQ** using the `command line` or the `GUI`.
+```shell
+./aq <file> -other-options
+```
+
+Please see [documentation](#document) for details
+
+## Document
+
+You can find more information about **AQ** in the <a href="/docs/index.md">Documentation</a>.
+
+> The current document may contain some errors or missing parts. We will improve it as soon as possible. If you find any bugs or areas for improvement, please feel free to <a href="https://github.com/aq-org/AQ/issues/new">contact us</a>.
+
+## Language Standard
+
+You can find information in <a href="/docs/standard.md">Language standards</a>.
+
+## Contributors
+
+AQ is an open source project and everyone is welcome to contribute to it! Whether it's filing a bug report, participating in code development, improving documentation, or providing suggestions, any kind of contribution is highly appreciated.
+
+## License
+
+**AQ** is based on `AGPL-3.0` and [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 `AGPL-3.0` and `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 `AGPL-3.0` and `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 `AGPL-3.0` and `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 and AQ License. You can find the AQ license in the root directory.