Skip to content

Commit

Permalink
Update readme (#77)
Browse files Browse the repository at this point in the history
* added contributing guidelines

* updated readme

* updated contributing
  • Loading branch information
Stateford authored Oct 6, 2018
1 parent e583d63 commit e21455f
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue or PR.

## Things to Avoid

1. Please do not add external dependencies or libraries without discussing them first.
2. The goal of this program is keep the program as lightweight as possible. Try to avoid things that might add uneeded bloat.
3. Do not manually increase the version number, or touch the build scripts unless it is related to the issue.
4. Do not make machine specific changes to solutions or projects. The project should be able to build on any machine with the files provided.
5. Do not use a build system other than MSBUILD.
6. Code Style is not strict, but try to follow what is already in the project.

## Pull Request Process

1. Coordinate work being done via issues or PR before work is done.
2. All work must be done on the develop branch or a branch checked out from develop.
3. Update the [CHANGELOG](CHANGELOG.md) with details of changes made.
4. If tests can be added, consider adding them.
5. All builds must actually build, pass pre-scripts, and all tests before being merged.

10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ Lightweight program that locks cursor in selected window, designed with performa
- Keeps cursor in a windowed game to prevent clicking outside
- Will stay active while the window is focused
- Keeps cursor in a fullscreen game while using a multi-monitor setup
- Converts any window into a borderless fullscreen window (when set in settings)
- Converts any window into a borderless and/or fullscreen window (when set in settings)

### EXAMPLE
#### Contributing
----------------------
Contributions are always welcome, but please check [Contributing](CONTRIBUTING.md) guidelines before making a pull request.

#### EXAMPLE
---------------
![](res/displayLock-preview.png)

Expand All @@ -21,3 +25,5 @@ Lightweight program that locks cursor in selected window, designed with performa
![](res/example.gif)

# ![Download](https://github.com/idietmoran/Display-Lock/releases/)

[Beta builds can be found from appveyor artifacts](https://ci.appveyor.com/project/idietmoran/display-lock/history)

0 comments on commit e21455f

Please sign in to comment.