docs: update docs

This commit is contained in:
x-tools-author 2025-03-06 13:46:28 +08:00
parent 355a4c64ae
commit ea1006af4b

View File

@ -6,35 +6,46 @@ description: "xTools项目简介。"
permalink: /
---
This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] the [README] file explains how to do that, along with other details.
*xTools*(曾用名QtSwissArmyKnife瑞士军刀QSAK)是一款开始于2018年基于Qt开发的开源、免费跨平台、多功能
的开发调试工具支持串口蓝牙UDPTCP, Web Socket, Modbus和CAN Bus调试。该工具旨在为开发者提供一个强大的
调试平台,简化各种通信协议的调试过程,提高开发效率。
If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.
*xTools*提供但不限于以下功能:
## 1122
* 支持数据发送与接受
* 支持2进制8进制16进制, ASCII及UTF8等文本格式的输出入及输出
* 支持添加前缀,后缀:'\r', '\n', '\r\n'或'\n\r'
* 支持输入文本转义:'\r', '\n', '\r\n\n\r'等
* 支持自动计算CRC支持以下但不限于算法
* CRC_8,
* CRC_8_ITU,
* CRC_8_ROHC,
* CRC_8_MAXIM,
* CRC_16_IBM,
* CRC_16_MAXIM,
* CRC_16_USB,
* CRC_16_MODBUS,
* CRC_16_CCITT,
* CRC_16_CCITT_FALSE,
* CRC_16_x25,
* CRC_16_XMODEM,
* CRC_16_DNP,
* CRC_32,
* CRC_32_MPEG2
* 支持自动发送,自动回复,预置数据,数据转发等
* 支持数据可视化:曲线显示,条形图显示
More specifically, the created site:
此外*xTools*还提供了一系列实用工具:
- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
[Browse our documentation][Just the Docs] to learn more about how to use this theme.
To get started with creating a site, simply:
1. click "[use this template]" to create a GitHub repository
2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.
----
[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
[GitHub Pages]: https://docs.github.com/en/pages
[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
[Jekyll]: https://jekyllrb.com
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
* ASCII工具: ASCII字符信息查看
* Base64工具Base64编码与解码
* 广播工具: UDP广播
* CRC工具CRC计算器
* 文件检验工具支持MD5Hash等算法
* 文件合并工具支持将多个bin文件合并为一个
* mDNS工具mDNS设备扫面工具可以扫描在线设备并查看设备信息
* 数值工具可以将数值转换为2进制8进制10禁止和16进制字符串也可以从文本转换为数值int, double...
* ping工具可以扫面局域网主机
* 二维码工具:二维码生成工具
* 字符串工具可以从2进制8进制10禁止和16进制数据中编码为字符串ASCIIUTF8
* ...