learning

开心就好

仓库内容与组织方式

该仓库包含各种计算机技能的代码片段以及个人笔记，并且按照编程语言进行归类组织，包括但不限于

.
├── python
│   ├── python
│   ├── pytorch
│   ├── tensorflow
│   └── scipy
├── linux
│   ├── docker
│   ├── git
│   └── shell
└── cpp
    ├── cpp
    ├── STL
    ├── cmake
    └── boost

通常一级目录夹表示编程语言，二级目录表示基于该语言的库。这些文件夹下的文件通常可以按照文件名推断其用处

xxx.md：说明性文字，例如README.md通常会包含该库的官网、文档等链接，安装命令以及最小可运行代码示例minimum working example (MWE)
draft_x.y: 代码片段，例如draft00.py通常是一系列的代码片段，建议在交互式环境下（例如ipython/bash）运行并观察结果
demo_x.y：函数封装的代码片段，通常由draft_x.y整理而来，例如python/matplotlib/demo_3d.py展示三维图像绘制
- 但并非所有的draft都适合整理为demo
test_x.y：单元测试代码片段，通常由demo_x.y整理而来，例如python/scipy/test_linalg.py中会测试svd分解得到的U矩阵是幺正的
- 调试特定库的错误时，我有时会运行一遍这些test_x.y文件（命令行下输入pytest -v xxx即可）来确保库的安装是正确的
ws_xx/文件夹：当一个功能无法用一个draft_x.y文件来展示时，便放在单独的文件夹下
- ws是workspce的缩写

如何使用该仓库

学习某个具体的库：找到该库所在的目录，先阅读README.md，其中包含参考链接以及安装命令，然后依次是draft_x.y运行一系列的代码片段。这些代码片段往往是自明的，但也因为缺少注释而显得晦涩难懂，建议同时阅读README.md中记录的官方文档
从最小代码片段构建项目代码：draft_x.y中包含一系列的最小可运行代码片段，作为构建项目的基础砖块再合适不过
对项目代码中不确定的代码行为，编写最小运行代码来确定其行为，并记录于该仓库
构建自己的笔记系统：每个人的知识体系差异巨大，所需要的笔记系统自然也会很不一样。笔者认为重要的工具也许完全不适用于其他领域，但笔记的组织方式应该是通用的。因此笔者强烈建议读者开始建立自己的笔记系统

其他

该仓库不接受pull request
- 该仓库的组织方式以及内容很大程度上是个人风格决定的，且很难达成共识（行宽，空格，换行等）
- 每个人的笔记系统会很不一样，我很难想象有人会在该仓库的基础上进一步添加内容，也许重头建立个人专属的笔记系统会更合适
- 如果你一定需要在该仓库的基础上进一步添加内容，直接fork该仓库并添加内容就好了
关于license
- 选择license是一件极其头疼的事情，见choose-a-license 开源指南等。直到我看到这个Linus对于GNUv2协议的解释「我給你源代碼，你給我你對它的修改，我們就扯平了I give you source code, you give me your changes back, we are even.」，我很喜欢这个简洁的解释，所以我选择GNUv2
- 必须承认的是，这个仓库的大部分文字是“偷”来的。通过阅读其他仓库的源码和文档，吸收其中的关键部分组成这个仓库，最糟糕的是部分代码只是复制粘贴而无理解吸收（明显的抄袭行为），但愿之后我会有空整理这类代码。对于其中license不兼容的文字，恳请告知，我会将其删除

BraveDrXuTF/learning

learning

仓库内容与组织方式

如何使用该仓库

其他

TODO