AlgoPlasma Quick Start

AlgoPlasma 快速入门

先选路线，不要一上来读完整仓库。只是想调用 AlgoPlasma 的人走“使用者路线”；要参与维护和开发的人走“开发者路线”。

选路线 跑通一个例子 调用一个子程序 再决定是否参与开发

路线一：只想调用 AlgoPlasma

目标是把库用起来。重点是怎么拿到源码、怎么跑一个已有测试、怎么在自己的程序里调用算法模块或子程序。

进入使用者快速入门

路线二：参与 AlgoPlasma 开发

目标是能安全地改库。重点是目录结构、测试位置、文档入口、第一次贡献和提交前检查。

进入开发者快速入门

怎么判断选哪条

  • 只想在自己的程序里调用 AlgoPlasma 子程序：看使用者路线。

  • 要给 AlgoPlasma 补文档、补测试、改算法或维护模块：看开发者路线。

AlgoPlasma Quick Start

Pick a route first. If you only want to call AlgoPlasma routines, use the user route. If you want to maintain or extend the library, use the developer route.

Pick a route Run one example Call one routine Then decide whether to develop

Route 1: Call AlgoPlasma Routines

The goal is to use the library. Focus on getting the source tree, running one existing test, and calling one algorithm module or public routine from your own code.

Open User Quick Start

Route 2: Develop AlgoPlasma

The goal is to change the library safely. Focus on the directory layout, test locations, documentation entry points, first contributions, and pre-submit checks.

Open Developer Quick Start

Which Route To Choose

  • To call AlgoPlasma routines from your own code, use the user route.

  • To write documentation, add tests, change algorithms, or maintain modules, use the developer route.

  • Neither route requires understanding the full PIC workflow first.