Starklings Cairo 1 项目教程
1. 项目目录结构及介绍
starklings-cairo1/
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── README.md
├── info.toml
├── editorconfig
├── gitignore
├── github/
│ └── workflows/
├── vscode/
├── corelib/
├── exercises/
│ └── new_module/
│ └── new_exercise.cairo
├── runner-crate/
├── src/
├── tests/
└── solutions/
目录结构介绍
- Cargo.lock: 锁定依赖版本的文件。
- Cargo.toml: 项目的配置文件,包含依赖项和构建配置。
- LICENSE: 项目的开源许可证文件。
- README.md: 项目的介绍和使用说明。
- info.toml: 项目的信息配置文件。
- editorconfig: 编辑器配置文件,用于统一代码风格。
- gitignore: Git 忽略文件配置。
- github/workflows/: GitHub Actions 的工作流配置文件。
- vscode/: Visual Studio Code 的配置文件。
- corelib/: 核心库文件。
- exercises/: 练习文件,包含多个模块和练习题。
- runner-crate/: 运行器库文件。
- src/: 项目源代码文件。
- tests/: 测试文件。
- solutions/: 练习题的解决方案文件。
2. 项目启动文件介绍
项目的启动文件主要是 Cargo.toml
和 README.md
。
Cargo.toml
Cargo.toml
是 Rust 项目的配置文件,包含了项目的元数据、依赖项、构建配置等信息。以下是部分内容示例:
[package]
name = "starklings-cairo1"
version = "0.1.0"
edition = "2021"
[dependencies]
cairo-lang = "0.1.0"
README.md
README.md
是项目的介绍和使用说明文件,包含了项目的安装、运行、贡献等信息。以下是部分内容示例:
# Starklings Cairo 1
这是一个交互式教程,帮助你快速上手 Cairo v1 和 Starknet。
## 安装
确保你已经安装了 Rust 和 Cargo,然后运行以下命令:
```bash
cargo install starklings
运行
运行以下命令启动教程:
cargo run -r --bin starklings watch
贡献
感谢你对项目的兴趣,欢迎提交 PR 和反馈。
## 3. 项目的配置文件介绍
项目的配置文件主要包括 `Cargo.toml` 和 `info.toml`。
### Cargo.toml
`Cargo.toml` 是 Rust 项目的配置文件,包含了项目的元数据、依赖项、构建配置等信息。以下是部分内容示例:
```toml
[package]
name = "starklings-cairo1"
version = "0.1.0"
edition = "2021"
[dependencies]
cairo-lang = "0.1.0"
info.toml
info.toml
是项目的信息配置文件,包含了项目的版本、作者等信息。以下是部分内容示例:
version = "0.1.0"
author = "shramee"
通过以上配置文件,可以了解项目的版本、依赖项、作者等信息,方便进行项目的管理和维护。