风格指南

本节贡献者

田冬冬(作者)、 姚家园(审稿)

最近更新日期

2021-02-06


  1. 为每个软件创建单独的文件夹

  2. 每个软件的教程应包括如下内容:

    • 索引文件 (index.rst): 列举软件和教程的元信息

    • 简介 (introduction.rst): 主要用途、功能、特色、缺点、相关文献及引用方式

    • 安装 (install.rst): 安装说明

    • 其它可选教程

      • 使用说明

      • 实战练习

  3. 其他规则请参考《地震“学”贡献指南》