《Solidity 高级程序设计》开源项目使用手册

#《Solidity 高级程序设计》开源项目使用手册

professional-solidity《Solidity 高级程序设计》面向专业开发者的Solidity教程！目前已经完成了最初的 V0.0.1 版本项目地址:https://gitcode.com/gh_mirrors/pr/professional-solidity

---

1. 项目目录结构及介绍

《Solidity 高级程序设计》是一个专为专业开发者准备的Solidity高级教程项目，其GitHub仓库位于https://github.com/anbang/professional-solidity。以下是该项目的目录结构概览及其主要内容介绍：

.
├── docs                  # 文档目录，包含了教程的源码
│   ├── ...
│   └── README.md        # 教程的中文读我文件
├── gitignore             # Git忽略文件配置
├── LICENSE               # 开源许可证文件，采用MIT License
├── README.md             # 主要的英文介绍文件
├── requirements.txt      # Python依赖列表，用于构建文档
├── start.sh              # 脚本文件，用于一键启动本地文档服务器
└── ...                   # 其它潜在的辅助或配置文件

主要模块解析:

• docs: 包含了所有教程的Markdown格式内容，是学习的核心资料。
• README.md: 提供简短的项目介绍和快速入门指南，以及必要的前置知识要求。
• gitignore: 指定了不应被Git追踪的文件类型。
• LICENSE: 明确了项目使用的MIT开放源代码许可协议。
• requirements.txt: 列出了生成文档所需的Python包，如Sphinx等。
• start.sh: 自动化脚本，简化本地搭建文档环境的过程。

2. 项目的启动文件介绍

• start.sh

  这是一个shell脚本，用于简化文档的本地预览过程。通过执行此脚本，用户无需手动执行一系列命令即可启动一个Web服务器，预览教程文档。具体执行命令如下：

  # 在项目根目录下执行此命令
  ./start.sh
  

  或者，对于开发者，也可以选择手动执行sphinx-autobuild命令：

  sphinx-autobuild docs build/html
  

  上述命令将监视docs目录下的变化，并实时更新到build/html目录，以便在浏览器中查看。

3. 项目的配置文件介绍

• 配置文件主要是指.gitignore和requirements.txt

  • .gitignore 不直接涉及项目的实际运行或配置，但它对于管理版本控制系统中不希望被提交的文件（如IDE缓存、个人配置等）至关重要。

  • requirements.txt 是项目的一个关键配置文件，列出了构建和运行项目文档所需的第三方Python包。通过pip安装这些包，确保了文档构建环境的一致性。例如，使用以下命令安装相关依赖：

    pip3 install -r requirements.txt
    

    这些依赖主要用于生成高质量的Sphinx文档。

综上所述，《Solidity 高级程序设计》项目提供了详尽的学习材料，通过上述目录结构、启动文件和配置文件的介绍，开发者和学习者能够便捷地开始他们的Solidity高级之旅。

professional-solidity《Solidity 高级程序设计》面向专业开发者的Solidity教程！目前已经完成了最初的 V0.0.1 版本项目地址:https://gitcode.com/gh_mirrors/pr/professional-solidity