This repository has been archived by the owner on Apr 13, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Not deleting the docs folder to prevent broken links
- Loading branch information
1 parent
9bb500d
commit 82fcc2d
Showing
12 changed files
with
27 additions
and
899 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1 @@ | ||
| # 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, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to creating a positive environment include: | ||
|
|
||
| * Using welcoming and inclusive language | ||
| * Being respectful of differing viewpoints and experiences | ||
| * Gracefully accepting constructive criticism | ||
| * Focusing on what is best for the community | ||
| * Showing empathy towards other community members | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| * The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
| * Trolling, insulting/derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
|
||
| ## Our Responsibilities | ||
|
|
||
| Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
|
||
| ## Scope | ||
|
|
||
| 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. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems 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. | ||
|
|
||
| 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 [http://contributor-covenant.org/version/1/4][version] | ||
|
|
||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/4/ | ||
| See [here](https://mathewsachin.github.io/Captura/code_of_conduct). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1 @@ | ||
| # Contributing | ||
|
|
||
| Want to Help? You can help by starring this repo, contributing code, testing and reporting bugs. | ||
|
|
||
| You can always [Chat on Gitter](https://gitter.im/MathewSachin/Captura) for Questions/Discussions. | ||
|
|
||
| ## Contributing Code | ||
|
|
||
| When contributing major changes to this repository, please first discuss the change you wish to make via issue, email, or any other method before making a change. | ||
|
|
||
| ## Reporting Issues | ||
|
|
||
| - Check the [FAQ](docs/FAQ.md) | ||
| - Check if a similar issue is already reported. If so then comment on that issue with details specific to your case. | ||
| - Check if the issue is resolved on the latest commit. | ||
| - If possible, Include **steps** to replicate the problem or a sample project. | ||
|
|
||
| ## Translations | ||
|
|
||
| See [here](docs/Translation.md). | ||
|
|
||
| ## Donations | ||
|
|
||
| Captura is made and maintained in personal time and is completely Ad-Free. | ||
| You can support this project by donating. | ||
|
|
||
| - [Paypal][paypal] | ||
|
|
||
| ### Donation History | ||
|
|
||
| See [here](https://mathewsachin.github.io/Captura/donate). | ||
|
|
||
| [paypal]: https://www.paypal.me/MathewSachin | ||
| See [here](https://mathewsachin.github.io/Captura/contributing). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1 @@ | ||
| # Building | ||
|
|
||
| ## Requirements | ||
|
|
||
| - [Visual Studio 2017](https://visualstudio.com) or greater is recommended. Can also be built using Visual Studio 2015 using [Microsoft.Net.Compilers](https://www.nuget.org/packages/Microsoft.Net.Compilers) nuget package to support compilation of C# 7. | ||
| - .Net Framework v4.6.1 is required. | ||
|
|
||
| ## Api Keys | ||
|
|
||
| Api Keys are loaded from user environment variables during development and embedded in Release builds if using Cake. | ||
|
|
||
| Service | Environment Variable | ||
| --------|---------------------- | ||
| Imgur | `imgur_client_id` | ||
|
|
||
| ## FFMpeg | ||
|
|
||
| FFMpeg can be downloaded from within the app. | ||
|
|
||
| ## Building using Cake | ||
|
|
||
| We use Cake (C# Make) to automate the build process. | ||
|
|
||
| To do a Release build, open powershell in project folder and type: `./build.ps1`. | ||
|
|
||
| The build is then available in the `Output` folder. | ||
|
|
||
| ### Options Supported by build script | ||
|
|
||
| Option | Description | ||
| -----------------|------------- | ||
| `-version` | Build version. `AssemblyInfo.cs` files are updated with this value during build. | ||
| `-configuration` | Configuration: *Release* or *Debug* | ||
| `-target` | The Task to run in the build script. See `build.cake` | ||
|
|
||
| e.g. `./build.ps1 -target "Pack-Setup" -version 5.6.0` | ||
|
|
||
| ## Building Manually | ||
|
|
||
| Some extra things that need to be done when building manually. | ||
|
|
||
| ### NuGet | ||
|
|
||
| Restore NuGet packages. | ||
|
|
||
| ### Audio | ||
|
|
||
| Download [BASS Audio library](http://www.un4seen.com/download.php?bass24) and [BASSmix](http://www.un4seen.com/download.php?bassmix24). | ||
|
|
||
| `bass.dll` and `bassmix.dll` (x86 versions, since Capture runs in `Prefer32Bit` mode) need to be placed in the same directory as `Captura.exe`. | ||
| See [here](https://mathewsachin.github.io/Captura/build). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1 @@ | ||
| # Continuous Integration | ||
|
|
||
| We use [AppVeyor](https://ci.appveyor.com/project/MathewSachin/Captura) for Continuous Integration. | ||
|
|
||
| When a commit is pushed to the GitHub repository, AppVeyor clones the repo and builds, tests and deploys it. | ||
|
|
||
| ## Build | ||
|
|
||
| NuGet packages directory is cached until no `packages.config` files change. | ||
|
|
||
| The build output along with dependencies is packaged as a Zip file. | ||
| License files, BASS and BassMix dlls are downloaded and included in the build output. | ||
|
|
||
| On Tag builds, version is determined from the tag name. | ||
| Otherwise, `AssemblyInfo.cs` files are used. | ||
|
|
||
| Release builds include the main exe, dll files and config file. | ||
| Debug builds include PDB (Symbol Database Files) and XML documentation files in addition to those in Release builds. | ||
|
|
||
| ## Test | ||
|
|
||
| ScreenShots of `captura.ui.exe` are taken using `captura shot`. | ||
|
|
||
| ~~On Tag builds, the ScreenShots on the website are updated.~~ | ||
|
|
||
| ## Deploy | ||
|
|
||
| AppVeyor automates the Release process. | ||
|
|
||
| Tags are used to indicate a release. | ||
| Tag format is verified to match `v{Major}.{Minor}.{Patch}[-{prerelease}]`. When tag does not match this format, build fails. | ||
|
|
||
| `AssemblyInfo.cs` files are updated as per the tag. | ||
|
|
||
| Api keys for Imgur are written into the app. | ||
|
|
||
| The application is deployed to GitHub Releases as a Draft. | ||
| Also, Chocolatey package is prepared corresponding to the GitHub Release. | ||
| It can be manually deployed once the GitHub Releases draft is published. | ||
|
|
||
| ## Getting the Dev Builds | ||
|
|
||
| 1. Go to [AppVeyor project](https://ci.appveyor.com/project/MathewSachin/Captura) page. | ||
|
|
||
| 2. Select Build Configuration: **Debug** or **Release**. | ||
|
|
||
| 3. Open **Artifacts** tab. | ||
|
|
||
| 4. Download **Zip package**. | ||
|
|
||
| **Warning: Dev builds can be unstable and should be used for testing purposes only.** | ||
| See [here](https://mathewsachin.github.io/Captura/ci). |
Oops, something went wrong.
82fcc2dThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure where to comment really, but according to Windows 10 this version is a Virus?
82fcc2dThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be mistaking the keystroke capture functionality for a virus