Skip to content
This repository was archived by the owner on Apr 13, 2023. It is now read-only.

Commit 82fcc2d

Browse files
committed
Point Documentation to New Website
Not deleting the docs folder to prevent broken links
1 parent 9bb500d commit 82fcc2d

File tree

12 files changed

+27
-899
lines changed

12 files changed

+27
-899
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1 @@
1-
# Contributor Covenant Code of Conduct
2-
3-
## Our Pledge
4-
5-
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.
6-
7-
## Our Standards
8-
9-
Examples of behavior that contributes to creating a positive environment include:
10-
11-
* Using welcoming and inclusive language
12-
* Being respectful of differing viewpoints and experiences
13-
* Gracefully accepting constructive criticism
14-
* Focusing on what is best for the community
15-
* Showing empathy towards other community members
16-
17-
Examples of unacceptable behavior by participants include:
18-
19-
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20-
* Trolling, insulting/derogatory comments, and personal or political attacks
21-
* Public or private harassment
22-
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23-
* Other conduct which could reasonably be considered inappropriate in a professional setting
24-
25-
## Our Responsibilities
26-
27-
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.
28-
29-
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.
30-
31-
## Scope
32-
33-
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.
34-
35-
## Enforcement
36-
37-
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.
38-
39-
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.
40-
41-
## Attribution
42-
43-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44-
45-
[homepage]: http://contributor-covenant.org
46-
[version]: http://contributor-covenant.org/version/1/4/
1+
See [here](https://mathewsachin.github.io/Captura/code_of_conduct).

CONTRIBUTING.md

Lines changed: 1 addition & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1 @@
1-
# Contributing
2-
3-
Want to Help? You can help by starring this repo, contributing code, testing and reporting bugs.
4-
5-
You can always [Chat on Gitter](https://gitter.im/MathewSachin/Captura) for Questions/Discussions.
6-
7-
## Contributing Code
8-
9-
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.
10-
11-
## Reporting Issues
12-
13-
- Check the [FAQ](docs/FAQ.md)
14-
- Check if a similar issue is already reported. If so then comment on that issue with details specific to your case.
15-
- Check if the issue is resolved on the latest commit.
16-
- If possible, Include **steps** to replicate the problem or a sample project.
17-
18-
## Translations
19-
20-
See [here](docs/Translation.md).
21-
22-
## Donations
23-
24-
Captura is made and maintained in personal time and is completely Ad-Free.
25-
You can support this project by donating.
26-
27-
- [Paypal][paypal]
28-
29-
### Donation History
30-
31-
See [here](https://mathewsachin.github.io/Captura/donate).
32-
33-
[paypal]: https://www.paypal.me/MathewSachin
1+
See [here](https://mathewsachin.github.io/Captura/contributing).

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
[![Master Build Status](https://img.shields.io/appveyor/ci/MathewSachin/Captura/master.svg?style=flat-square)](https://ci.appveyor.com/project/MathewSachin/Captura)
44
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE.md)
55
[![Chat](https://img.shields.io/badge/chat-on_gitter-yellow.svg?style=flat-square)](https://gitter.im/MathewSachin/Captura)
6-
[![Downloads](https://img.shields.io/github/downloads/MathewSachin/Captura/total.svg?style=flat-square)](https://github.com/MathewSachin/Captura/releases)
7-
[![PayPal Donate](https://img.shields.io/badge/donate-PayPal-orange.svg?style=flat-square)](https://www.paypal.me/MathewSachin)
6+
[![Downloads](https://img.shields.io/github/downloads/MathewSachin/Captura/total.svg?style=flat-square)](https://mathewsachin.github.io/Captura/download)
7+
[![PayPal Donate](https://img.shields.io/badge/donate-PayPal-orange.svg?style=flat-square)](https://mathewsachin.github.io/Captura/donate)
88

99
© [Copyright 2018](LICENSE.md) Mathew Sachin
1010

1111
:link: <https://mathewsachin.github.io/Captura/>
1212

1313
Capture Screen, WebCam, Audio, Cursor, Mouse Clicks and Keystrokes.
1414

15-
<a href="docs/ScreenShots.md"><img src="http://i.imgur.com/syPGnSd.png" align="right"></a>
15+
<a href="https://mathewsachin.github.io/Captura/screenshots"><img src="http://i.imgur.com/syPGnSd.png" align="right"></a>
1616

1717
## Features
1818

@@ -23,9 +23,9 @@ Capture Screen, WebCam, Audio, Cursor, Mouse Clicks and Keystrokes.
2323
- Capture Mouse Clicks or Keystrokes
2424
- Mix Audio recorded from Microphone and Speaker Output
2525
- Capture from WebCam.
26-
- Can be used from [Command-line](docs/CmdLine.md) (*BETA*).
27-
- Available in [multiple languages](docs/Translation.md)
28-
- Configurable [Hotkeys](docs/Hotkeys.md)
26+
- Can be used from [Command-line](https://mathewsachin.github.io/Captura/cmdline) (*BETA*).
27+
- Available in [multiple languages](https://mathewsachin.github.io/Captura/translation)
28+
- Configurable [Hotkeys](https://mathewsachin.github.io/Captura/hotkeys)
2929

3030
## Table of Contents
3131

@@ -38,15 +38,15 @@ Capture Screen, WebCam, Audio, Cursor, Mouse Clicks and Keystrokes.
3838
- [System Requirements](#system-requirements)
3939
- [FFMpeg](#ffmpeg)
4040
- Other Links
41-
- [Changelog](docs/Changelog.md)
42-
- [Continuous Integration](docs/CI.md)
43-
- [Contributing](CONTRIBUTING.md)
44-
- [Translation](docs/Translation.md)
45-
- [Code of Conduct](CODE_OF_CONDUCT.md)
46-
- [Command-line](docs/CmdLine.md)
47-
- [FAQ](docs/FAQ.md)
48-
- [Hotkeys](docs/Hotkeys.md)
49-
- [ScreenShots](docs/ScreenShots.md)
41+
- [Changelog](https://mathewsachin.github.io/Captura/changelog)
42+
- [Continuous Integration](https://mathewsachin.github.io/Captura/ci)
43+
- [Contributing](https://mathewsachin.github.io/Captura/contributing)
44+
- [Translation](https://mathewsachin.github.io/Captura/translation)
45+
- [Code of Conduct](https://mathewsachin.github.io/Captura/code_of_conduct)
46+
- [Command-line](https://mathewsachin.github.io/Captura/cmdline)
47+
- [FAQ](https://mathewsachin.github.io/Captura/faq)
48+
- [Hotkeys](https://mathewsachin.github.io/Captura/hotkeys)
49+
- [ScreenShots](https://mathewsachin.github.io/Captura/screenshots)
5050
- [License](#license)
5151

5252
## Installation
@@ -87,7 +87,7 @@ Dev builds can be unstable and should be used for testing purposes only.
8787

8888
- [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.
8989
- .Net Framework v4.6.1 is required.
90-
- For detailed information, see [Building](docs/Building.md).
90+
- For detailed information, see [Building](https://mathewsachin.github.io/Captura/build).
9191

9292
## System Requirements
9393

docs/Building.md

Lines changed: 1 addition & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1 @@
1-
# Building
2-
3-
## Requirements
4-
5-
- [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.
6-
- .Net Framework v4.6.1 is required.
7-
8-
## Api Keys
9-
10-
Api Keys are loaded from user environment variables during development and embedded in Release builds if using Cake.
11-
12-
Service | Environment Variable
13-
--------|----------------------
14-
Imgur | `imgur_client_id`
15-
16-
## FFMpeg
17-
18-
FFMpeg can be downloaded from within the app.
19-
20-
## Building using Cake
21-
22-
We use Cake (C# Make) to automate the build process.
23-
24-
To do a Release build, open powershell in project folder and type: `./build.ps1`.
25-
26-
The build is then available in the `Output` folder.
27-
28-
### Options Supported by build script
29-
30-
Option | Description
31-
-----------------|-------------
32-
`-version` | Build version. `AssemblyInfo.cs` files are updated with this value during build.
33-
`-configuration` | Configuration: *Release* or *Debug*
34-
`-target` | The Task to run in the build script. See `build.cake`
35-
36-
e.g. `./build.ps1 -target "Pack-Setup" -version 5.6.0`
37-
38-
## Building Manually
39-
40-
Some extra things that need to be done when building manually.
41-
42-
### NuGet
43-
44-
Restore NuGet packages.
45-
46-
### Audio
47-
48-
Download [BASS Audio library](http://www.un4seen.com/download.php?bass24) and [BASSmix](http://www.un4seen.com/download.php?bassmix24).
49-
50-
`bass.dll` and `bassmix.dll` (x86 versions, since Capture runs in `Prefer32Bit` mode) need to be placed in the same directory as `Captura.exe`.
1+
See [here](https://mathewsachin.github.io/Captura/build).

docs/CI.md

Lines changed: 1 addition & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1 @@
1-
# Continuous Integration
2-
3-
We use [AppVeyor](https://ci.appveyor.com/project/MathewSachin/Captura) for Continuous Integration.
4-
5-
When a commit is pushed to the GitHub repository, AppVeyor clones the repo and builds, tests and deploys it.
6-
7-
## Build
8-
9-
NuGet packages directory is cached until no `packages.config` files change.
10-
11-
The build output along with dependencies is packaged as a Zip file.
12-
License files, BASS and BassMix dlls are downloaded and included in the build output.
13-
14-
On Tag builds, version is determined from the tag name.
15-
Otherwise, `AssemblyInfo.cs` files are used.
16-
17-
Release builds include the main exe, dll files and config file.
18-
Debug builds include PDB (Symbol Database Files) and XML documentation files in addition to those in Release builds.
19-
20-
## Test
21-
22-
ScreenShots of `captura.ui.exe` are taken using `captura shot`.
23-
24-
~~On Tag builds, the ScreenShots on the website are updated.~~
25-
26-
## Deploy
27-
28-
AppVeyor automates the Release process.
29-
30-
Tags are used to indicate a release.
31-
Tag format is verified to match `v{Major}.{Minor}.{Patch}[-{prerelease}]`. When tag does not match this format, build fails.
32-
33-
`AssemblyInfo.cs` files are updated as per the tag.
34-
35-
Api keys for Imgur are written into the app.
36-
37-
The application is deployed to GitHub Releases as a Draft.
38-
Also, Chocolatey package is prepared corresponding to the GitHub Release.
39-
It can be manually deployed once the GitHub Releases draft is published.
40-
41-
## Getting the Dev Builds
42-
43-
1. Go to [AppVeyor project](https://ci.appveyor.com/project/MathewSachin/Captura) page.
44-
45-
2. Select Build Configuration: **Debug** or **Release**.
46-
47-
3. Open **Artifacts** tab.
48-
49-
4. Download **Zip package**.
50-
51-
**Warning: Dev builds can be unstable and should be used for testing purposes only.**
1+
See [here](https://mathewsachin.github.io/Captura/ci).

0 commit comments

Comments
 (0)