Skip to content

Commit

Permalink
Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
filoper committed Nov 21, 2020
1 parent d599fcf commit 94501d5
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 2 deletions.
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Proposed changes
*
*
*

### Pull Request Readiness Checklist

- [ ] The PR is proposed to proper branch
- [ ] If applicable, there is reference to original bug report and related work
- [ ] Code is formatted
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Contributing to ms-client

### DOs

* **DO** create one pull request per improvement.
* **DO** follow the [Coding and Style](#code-formatting) guidelines, and keep code changes as small as possible.
* **DO** link the issue you are addressing in the pull request.
* **DO** write a good description for your pull request. More detail is better.

### DO NOTs

* **DO NOT** merge multiple changes into one PR unless they have the same root cause.
* **DO NOT** merge directly into the master branch.

## Code Formatting

***Run clang-format***

Use the following commands from the project's root directory to run clang-format (must be installed on the host system).

**Run the CMake target for `clang-format`:**
````bash
cmake --build build --target clang-format
````
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Download and install the following:

* **Git**

* **CMake v3.14+** - found at [https://cmake.org/](https://cmake.org/)
* **CMake v3.14+ (3.18+ for Windows)** - found at [https://cmake.org/](https://cmake.org/)

* **Ninja v1.9.0+**

* **C++ Compiler** - needs to support at least the **C++20** standard, i.e. *MSVC*,
*GCC*, *Clang*

* **Homebrew (Mac OS ONLY)** - found at [https://brew.sh/](https://brew.sh/)
* **Homebrew (MacOS ONLY)** - found at [https://brew.sh/](https://brew.sh/)

* **Visual Studio 2019 (Windows ONLY)**

Expand Down Expand Up @@ -55,6 +55,10 @@ brew install lz4
brew install glfw
```

```bash
brew install freetype
```

#### Linux
```bash
Download BASS from https://www.un4seen.com and place inside `ms-client/thirdparty`.
Expand Down

0 comments on commit 94501d5

Please sign in to comment.