Skip to content
This repository has been archived by the owner on Dec 23, 2022. It is now read-only.

Commit

Permalink
Update documents.
Browse files Browse the repository at this point in the history
  • Loading branch information
MouriNaruto committed Dec 9, 2018
1 parent f598aa0 commit c060fbb
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 55 deletions.
26 changes: 14 additions & 12 deletions CODE_OF_CONDUCT.md
@@ -1,13 +1,13 @@
# Contributor Covenant Code of Conduct
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
our community a harassment-free experience for everyone, regardless of age,
body size, disability, ethnicity, sex characteristics, gender identity and
expression, level of experience, education, socio-economic status, nationality,
personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Expand Down Expand Up @@ -48,27 +48,29 @@ threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
address, posting via an official social media account, or acting as an
appointed representative at an online or offline event. Representation of
project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at Mouri_Naruto@Outlook.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
obligated to maintain confidentiality with regard to the reporter of an
incident. Further details of specific enforcement policies may be posted
separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

Expand Down
49 changes: 48 additions & 1 deletion CONTRIBUTING.md
@@ -1 +1,48 @@
# Contributing to NSudo
# Contributing to NSudo

## How to become a contributor
- Direct contributions
- **Create pull requests directly.**
- Please send e-mails to Mouri_Naruto@Outlook.com if you have any
questions.
- Feedback suggestions and bugs.
- We use GitHub issues to track bugs and features.
- For bugs and general issues please
[file a new issue](https://github.com/M2Team/NSudo/issues/new).

## Code contribution guidelines

### Prerequisites
- Visual Studio 2017 version 15.9 or later.
- Install from here: http://visualstudio.com/downloads
- You also need install ARM and ARM64 components.
- Windows 10 version 1507 SDK or later.
- You need to change the Windows SDK version in the project properties if the
version of Windows 10 SDK I used isn't installed on your PC.
- You also need install ARM and ARM64 components when you installing the
Windows 10 Version 1703 SDK or later.
- (Optional but recommend) If you want to reduce the release mode binaries size
for x86, x64 and ARM64 port of NSudo, you can use VC-LTL.
- VC-LTL GitHub Repository: https://github.com/Chuyu-Team/VC-LTL
- How to use VC-LTL to optimize NSudo binaries size:
- Download VC-LTL binary pack from
https://github.com/Chuyu-Team/VC-LTL/releases/latest.
- Unpack the VC-LTL binary pack and double-click install.cmd in the unpack
folder.

## Code style and conventions
- C++: [C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md)
- C#: Follow the .NET Core team's [C# coding style](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/coding-style.md)

For all languages respect the [.editorconfig](https://editorconfig.org/) file
specified in the source tree. Many IDEs natively support this or can with a
plugin.

### Copying files from other projects
The following rules must be followed for PRs that include files from another
project:
* The license of the file is
[permissive](https://en.wikipedia.org/wiki/Permissive_free_software_licence).
* The license of the file is left intact.
* The contribution is correctly attributed in the [Readme](Readme.md)
file in the repository, as needed.
3 changes: 3 additions & 0 deletions NSudo.sln
Expand Up @@ -7,10 +7,13 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "NSudo", "NSudo\NSudo.vcxpro
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Documents", "Documents", "{C3C42858-2A8F-492A-9B80-B11907E0C95D}"
ProjectSection(SolutionItems) = preProject
.editorconfig = .editorconfig
.gitignore = .gitignore
.gitmodules = .gitmodules
appveyor.yml = appveyor.yml
Changelog.md = Changelog.md
CODE_OF_CONDUCT.md = CODE_OF_CONDUCT.md
CONTRIBUTING.md = CONTRIBUTING.md
LICENSE = LICENSE
Logo.png = Logo.png
People.md = People.md
Expand Down
27 changes: 5 additions & 22 deletions Readme.md
Expand Up @@ -146,34 +146,17 @@ For example:
- Copyright: Chuyu Team
- License: https://github.com/Chuyu-Team/VC-LTL/blob/master/LICENSE.txt

## Changelogs
See [Changelog.md](Changelog.md) for more details.

## Relevant People
See [People.md](People.md) for more details.

## Git Repositories
- GitHub (Main)
- https://github.com/M2Team/NSudo
- OSChina (Mirrors)
- https://gitee.com/M2-Team/NSudo

## The way to compile NSudo
- If you need to compile NSudo, you need to install Visual Studio 2017 first.
- You need to change the Windows SDK version in the project properties if the
version of Windows 10 SDK I used isn't installed on your PC. You also need
install ARM and ARM64 components when you installing the Windows 10 Version
1703 SDK or later.
- (Optional) If you want to reduce the release mode binaries size for x86, x64
and ARM64 port of NSudo, you can use VC-LTL.
- VC-LTL GitHub Repository: https://github.com/Chuyu-Team/VC-LTL
- How to use VC-LTL to optimize NSudo binaries size:
- Download VC-LTL binary pack from
https://github.com/Chuyu-Team/VC-LTL/releases/latest.
- Unpack the VC-LTL binary pack and double-click install.cmd in the unpack
folder.
- Compile NSudo by Visual Studio 2017.
- I hope these infomation can help you.
## Documents
- [NSudo's Changelog](Changelog.md)
- [NSudo's Relevant People](People.md)
- [NSudo's Code of Conduct](CODE_OF_CONDUCT.md)
- [Contributing to NSudo](CONTRIBUTING.md)

## Communication
- MDL Post: https://forums.mydigitallife.net/threads/59268/
Expand Down
25 changes: 5 additions & 20 deletions 自述.md
Expand Up @@ -129,32 +129,17 @@ PS:
- 版权:初雨团队
- 许可:https://github.com/Chuyu-Team/VC-LTL/blob/master/LICENSE.txt

## 更新日志
参见 [更新日志.md](更新日志.md)

## 相关人士
参见 [People.md](People.md)

## Git 仓库列表
- GitHub(主仓库)
- https://github.com/M2Team/NSudo
- OSChina(镜像仓库)
- https://gitee.com/M2-Team/NSudo

## 如何编译 NSudo
- 如果你需要编译 NSudo,那么首先需要安装 Visual Studio 2017。
- 如果你安装的 Windows 10 SDK 版本与我的不同,那么你需要修改项目属性中的
Windows 10 SDK 版本。如果安装的是 Windows 10 SDK Build 15063 及之后的版本请选
中 ARM 和 ARM64 组件。
- (可选)如果你想减小Release 编译模式的 x86、x86-64 和 ARM 的二进制大小,你可
以使用 VC-LTL。
- VC-LTL 的 GitHub 仓库:https://github.com/Chuyu-Team/VC-LTL
- 如何使用 VC-LTL 优化 NSudo 的二进制大小:
-https://github.com/Chuyu-Team/VC-LTL/releases/latest 下载 VC-LTL 的二
进制包。
- 解压 VC-LTL 包并运行解压目录下的 install.cmd。
- 使用 Visual Studio 2017 编译。
- 我希望这些信息能够帮上忙。
## 文档
- [NSudo 更新日志](更新日志.md)
- [NSudo 相关人士](People.md)
- [NSudo's Code of Conduct](CODE_OF_CONDUCT.md)
- [Contributing to NSudo](CONTRIBUTING.md)

## 联系方式
- MDL论坛帖子:https://forums.mydigitallife.net/threads/59268/
Expand Down

0 comments on commit c060fbb

Please sign in to comment.