vlcchina / VLCWikiForChinese

Translation of VLC wiki pages and improments
Other
8 stars 5 forks source link

VLCWikiForChinese

项目说明

本项目是vlccchina的官方wiki,主要来源是VLCwiki页面的翻译,以及vlc中文社区的志愿者的贡献。

预备知识

git和github的基本使用,教程参考链接:

项目内容

wiki的主要来源包括以下:

整体来看,VideoLAN的wiki组织比较松散,因此本项目致力于整合资源,以友好地方式回馈给开源社区。

项目组织

以文件夹的形式组织章节展开翻译,最后汇总成html和pdf。具体的分布如下:

分别对应于上面的项目内容。最后的vlc-wiki-utils存放翻译过程中需要的一些共用信息,比如文件头信息,也可以share一些教程,比如markdown的学习或者自己翻译的一些心得体会。

按照wiki中超链接的组织结构,建立文件夹的相应结构,从顶层目录到最底层目录,最底层目录对应超链接的最底层,在最底层目录放置翻译的源文件,即xx.md。

项目工作流程

VLC开发小组成员

具有直接edit并commit的权限,工作流简述如下:

1、clone项目

git clone git@github.com:vlcchina/VLCWikiForChinese.git

2、根据自己展开的工作建立分支,比如enjoythearchitecture的翻译,可以操作如下:

git branch enjoythearchitecture
git checkout enjoythearchitecture

3、 在新建分支进行翻译和编辑工作...

4、查看更改并提交,操作如下:

git checkout master
git merge enjoythearchitecture
git branch -d enjoythearchitecture
git diff
git add .
git commit -m 'yourcommentshere'
git push

5、 查看项目的提交记录并更新本地repo

git log
git pull

开源爱好者

如何你对本项目感兴趣,可以fork后进行pull request。

项目管理

本项目的翻译基于纯文本,使用MarkDown标记语言,关于MarkDown的基本使用,请参考Markdown语法说明

今后考虑使用Tex,Python、docutils和sphinx。

如果你有更好的建议,请给我们发送邮件。

VLC开发小组