Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[enhancement][docs] 重构 README #275

Closed
gaocegege opened this issue Jan 10, 2018 · 14 comments
Closed

[enhancement][docs] 重构 README #275

gaocegege opened this issue Jan 10, 2018 · 14 comments

Comments

@gaocegege
Copy link
Member

现在 README 跟 Wiki 内容有些重复, 相当于在维护两个版本, 我想重构下 README, 其中只保留最简单的构建方式并且加上 demo 截图, 其余构建的细节链接到 Wiki, 这样构建文档只需要维护一份, 各位意下如何

@goodbest @AlexaraWu @at15

@at15
Copy link
Member

at15 commented Jan 10, 2018

我觉得可以,另外 tex 模板里本身也有一部分重合的内容,感觉也可以顺便处理一下

@goodbest
Copy link
Collaborator

赞成。

tex模板里面的文字可以注明“此内容仅供参考,最新内容请参考wiki”

@gaocegege
Copy link
Member Author

tex模板里面的文字可以注明“此内容仅供参考,最新内容请参考wiki”

SGTM, 等 #47 分离了学位论文和使用文档, 我们应该就不需要再维护 tex 了

@AlexaraWu
Copy link
Collaborator

赞成 +1

新开个分支做?

@gaocegege
Copy link
Member Author

可以, 开一个 upstream 上的分支吧, 这样大家都有权限改, 另外 Wiki 的维护我现在在做 #257 , 各位谁有精力都可以去编辑现在的使用说明

@AlexaraWu 你来开一个?

@AlexaraWu
Copy link
Collaborator

@gaocegege 我好像没有 push 到 upstream 的权限。

@gaocegege
Copy link
Member Author

gaocegege commented Jan 10, 2018

@AlexaraWu 检查了一下, 你有的啊, 报错是啥

我在本地把自己的 push 权限关了, 再开很累..

@at15
Copy link
Member

at15 commented Jan 10, 2018

@gaocegege master 被 protect 了? (我没试,瞎猜的....

@AlexaraWu
Copy link
Collaborator

@gaocegege 弄好了,操作失误。

@gaocegege gaocegege changed the title [discussion][docs] 重构 README [enhancement][docs] 重构 README Jan 10, 2018
@AlexaraWu
Copy link
Collaborator

AlexaraWu commented Jan 13, 2018

2c87ee1

简单构建了 sjtuthesis.dtx 文件,包含模版和模版文档,内容有待丰富。

可以使用以下命令生成模版和文档:

make doc

@AlexaraWu AlexaraWu self-assigned this Jan 13, 2018
@AlexaraWu
Copy link
Collaborator

@htfy96 申请给一个 admin 权限。

@htfy96
Copy link

htfy96 commented Jan 14, 2018 via email

@AlexaraWu
Copy link
Collaborator

@gaocegege 这个 Issue 实际上和 #47 重复了,既然讨论结束了不是考虑关掉这个 Issue?

@gaocegege
Copy link
Member Author

Go ahead

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants