此代码库用于《系统动力学导入》工作坊的讲议、导入手册、参考练习、案例及参考文献索引等内容材料的版本管理,本代码库由社区协作者在2017年9月21日和22日一起共同完成,并基于此基础不断迭代梳理完善及优化。在遵循协议的前提下,您可以自由使用本代码库。
本工作坊为开源项目,贡献本项目请注意以下几点:
- 所有文档均以markdown格式进行编辑,markdown的格式请参考:Mastering Markdown,关于gitbook中markdown格式,可以参考gitbook markdown syntax,您可以使用任何markdown编辑器进行编辑,例如Typora ;
docs
目录为gitbook源代码所在目录,保存包括课程大纲、导师手册、参考练习及参考案例等在内的所有文档(注:后面均以源代码来泛指);docs/gitbook/images
目录保存的为docs
中文件所需使用到的图片文档;charts
目录保存的为系统图编写的文档,推荐的编辑工作为 VensimPLE;- 为便于文件版本管理,所有文件、目录均以英文字母或阿拉伯数字命名,文件名要全部小写, 可以包含下划线 (
_
) ,可接受的文件命名示例:cld_overview.md
complicated_system_cases_study.md
cldoverview.md
//_overview.md
等已弃用。
您的贡献不仅仅只局限于直接的文本编写及图片绘制,并提交pull request
等,您同样可以在Issues页面给我们提出问题及修改建议,任何有价值的反馈都帮助我们完善本材料。
此代码库生成的gitbook已经部署在本项目主页https://erizhang.github.io/systemdynamics ,直接访问该gitbook,可以了解最新版本的内容。
如需修改,您只需按以下步骤操作:
- 将此代码库
git clone
到本地,可以进行源代码的修改; - 完成修改后,可执行
git commit
完成源代码修改的提交(如果您拥用此代码库的master权限,您可以直接将修改push
至远端代码库),或执行git stash
进行缓存; - 若对源代码的修改有不确定之处,可提交
pull request
,交由本代码库的所有者审核; - 执行
./publish_gitbook.sh
命令,可以生成新的gitbook,并同时自动将新生成gitbook发布到本项目主页。
关于更多gitbook的使用,请移步参考gitbook主页
本项目为开源项目,遵循xxx协议 //TBD