重构: aiohttp 全异步 + chessdb 云库 + uv 管理

2026-09-13 13:50:11 +08:00
commit 982f8306a3
@@ -0,0 +1,168 @@
+<div align="center">
+
+  [![Pikafish][pikafish-logo]][website-link]
+
+
+  <h3>Pikafish</h3>
+
+  A free and strong UCI xiangqi engine.
+  <br>
+  <strong>[Explore Pikafish docs »][wiki-link]</strong>
+  <br>
+  <br>
+  [Report bug][issue-link]
+  ·
+  [Open a discussion][discussions-link]
+  ·
+  [Discord][discord-link]
+  ·
+  [Blog][website-blog-link]
+
+  [![Build][build-badge]][build-link]
+  [![License][license-badge]][license-link]
+  [![RuleBook][rulebook-badge]][rulebook-link]
+  <br>
+  [![Release][release-badge]][release-link]
+  [![Commits][commits-badge]][commits-link]
+  <br>
+  [![Website][website-badge]][website-link]
+  [![Fishtest][fishtest-badge]][fishtest-link]
+  [![Discord][discord-badge]][discord-link]
+
+</div>
+
+## Overview
+
+[Pikafish][website-link] is a **free and strong UCI xiangqi engine** derived from
+[Stockfish][stockfish-link] that analyzes xiangqi positions and computes the optimal moves.
+
+Pikafish **does not include a graphical user interface** (GUI) that is required
+to display a chessboard and to make it easy to input moves. These GUIs are
+developed independently from Pikafish and are available online. **Read the
+documentation for your GUI** of choice for information about how to use
+Pikafish with it.
+
+See also the Pikafish [documentation][wiki-usage-link] for further usage help.
+
+## Files
+
+This distribution of Pikafish consists of the following files:
+
+  * [README.md][readme-link], the file you are currently reading.
+
+  * [Copying.txt][license-link], a text file containing the GNU General Public
+    License version 3.
+
+  * [AUTHORS][authors-link], a text file with the list of authors for the official Pikafish project.
+
+  * [src][src-link], a subdirectory containing the full source code, including a
+    Makefile that can be used to compile Pikafish on Unix-like systems.
+
+  * a file with the .nnue extension, storing the neural network for the NNUE
+    evaluation.
+
+## Contributing
+
+__See [Contributing Guide](./CONTRIBUTING.md).__
+
+### Donating hardware
+
+Improving Pikafish requires a massive amount of testing. You can donate your
+hardware resources by installing the [Fishtest Worker][worker-link] and viewing
+the current tests on [Fishtest][fishtest-link].
+
+### Improving the code
+
+In the [chessprogramming wiki][programming-link], many techniques used in
+Pikafish are explained with a lot of background information.
+The [section on Stockfish][programmingsf-link] describes many features
+and techniques used by Stockfish. However, it is generic rather than
+focused on Stockfish's precise implementation.
+
+The engine testing is done on [Fishtest][fishtest-link].
+If you want to help improve Pikafish, please read this [guideline][guideline-link]
+first, where the basics of Pikafish development are explained.
+
+Discussions about Pikafish take place these days mainly in the Pikafish
+[Discord server][discord-link]. This is also the best place to ask questions
+about the codebase and how to improve it.
+
+
+## Compiling Pikafish
+
+Pikafish has support for 32 or 64-bit CPUs, certain hardware instructions,
+big-endian machines such as Power PC, and other platforms.
+
+On Unix-like systems, it should be easy to compile Pikafish directly from the
+source code with the included Makefile in the folder `src`. In general, it is
+recommended to run `make help` to see a list of make targets with corresponding
+descriptions.
+
+```
+cd src
+make -j profile-build
+```
+
+Detailed compilation instructions for all platforms can be found in our
+[documentation][wiki-compile-link]. Our wiki also has information about
+the [UCI commands][wiki-uci-link] supported by Pikafish.
+
+## Terms of use
+
+### GNU General Public License version 3
+
+Pikafish is free and distributed under the
+[**GNU General Public License version 3**][license-link] (GPL v3). Essentially,
+this means you are free to do almost exactly what you want with the program,
+including distributing it among your friends, making it available for download
+from your website, selling it (either by itself or as part of some bigger
+software package), or using it as the starting point for a software project of
+your own.
+
+The only real limitation is that whenever you distribute Pikafish in some way,
+you MUST always include the license and the full source code (or a pointer to
+where the source code can be found) to generate the exact binary you are
+distributing. If you make any changes to the source code, these changes must
+also be made available under GPL v3.
+
+## Acknowledgements
+
+Pikafish uses neural networks trained on [data provided by the Pika Xiangqi Zero
+project][px0-data-link], which is made available under the [Open Database License][odbl-link] (ODbL).
+
+[authors-link]:			https://github.com/official-pikafish/Pikafish/blob/master/AUTHORS
+[build-badge]:			https://img.shields.io/github/actions/workflow/status/official-pikafish/Pikafish/pikafish.yml?branch=master&style=for-the-badge&label=pikafish&logo=github
+[build-link]:				https://github.com/official-pikafish/Pikafish/actions/workflows/pikafish.yml
+[commits-badge]:		https://img.shields.io/github/commits-since/official-pikafish/Pikafish/latest?style=for-the-badge
+[commits-link]:			https://github.com/official-pikafish/Pikafish/commits/master
+[discord-badge]:			https://img.shields.io/discord/1013130558089478144?style=for-the-badge&label=discord&logo=Discord
+[discord-link]:			https://discord.com/invite/uSb3RXb7cY
+[discussions-link]:   https://github.com/official-pikafish/Pikafish/discussions/new
+[fishtest-badge]:			https://img.shields.io/website?style=for-the-badge&down_color=red&down_message=Offline&label=Fishtest&up_color=success&up_message=Online&url=https://test.pikafish.org
+[fishtest-link]:			https://test.pikafish.org
+[guideline-link]:			https://github.com/glinscott/fishtest/wiki/Creating-my-first-test
+[issue-link]:         https://github.com/official-pikafish/Pikafish/issues/new?assignees=&labels=&template=BUG-REPORT.yml
+[license-badge]:			https://img.shields.io/github/license/official-pikafish/Pikafish?style=for-the-badge&label=license&color=success
+[license-link]:			https://github.com/official-pikafish/Pikafish/blob/master/Copying.txt
+[pikafish-logo]:			https://pikafish.org/assets/logo_256.png
+[programming-link]:		https://www.chessprogramming.org/Main_Page
+[programmingsf-link]:	https://www.chessprogramming.org/Stockfish
+[qqgroup-link]:			https://jq.qq.com/?_wv=1027&k=FORWUh4W
+[readme-link]:			https://github.com/official-pikafish/Pikafish/blob/master/README.md
+[release-badge]:			https://img.shields.io/github/v/release/official-pikafish/Pikafish?style=for-the-badge&label=official%20release
+[release-link]:			https://github.com/official-pikafish/Pikafish/releases/latest
+[rulebook-badge]:		https://img.shields.io/badge/computer%20rule-20B2AA?style=for-the-badge&logo=mdbook
+[rulebook-link]:			https://pikafish.org/rule.html
+[src-link]:				https://github.com/official-pikafish/Pikafish/tree/master/src
+[stockfish-link]:			https://github.com/official-stockfish/Stockfish
+[uci-link]:				https://backscattering.de/chess/uci/
+[website-badge]:		https://img.shields.io/website?style=for-the-badge&down_color=red&down_message=Offline&label=website&up_color=success&up_message=Online&url=https://pikafish.org
+[website-link]:			https://pikafish.org
+[website-blog-link]:  https://pikafish.org/
+[wiki-link]:          https://github.com/official-pikafish/Pikafish/wiki
+[wiki-compile-link]:  https://github.com/official-pikafish/Pikafish/wiki/Compiling-from-source
+[wiki-uci-link]:      https://github.com/official-pikafish/Pikafish/wiki/UCI-&-Commands
+[wiki-usage-link]:    https://github.com/official-pikafish/Pikafish/wiki/Download-and-usage
+[worker-link]:			https://github.com/xyztnecniV/yolo
+[px0-data-link]:      https://www.kaggle.com/datasets/pikacat/px0data
+[odbl-link]:          https://opendatacommons.org/licenses/odbl/odbl-10.txt