Skip to content

Commit

Permalink
Added clarification to README
Browse files Browse the repository at this point in the history
  • Loading branch information
noodnik2 committed Mar 2, 2021
1 parent c4f188d commit 4ea6427
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
15 changes: 13 additions & 2 deletions README-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,29 @@ and/or less frustrating!

## Quick Links

- [Creating a Release](#creating-a-release)
- [Signing The Application Manifest](#signing-the-application-manifest)
- [LiveCam Webserver Tricks](#livecam-webserver-tricks)

## Creating A Release

See the [build file](.github/workflows/build.yml) for details, but
know that when you push a Git tag whose name ends with `-release`
to the repository, a new release will be built and created
using the current version of the code in that branch.

## Signing The Application Manifest

When trying to build this project for the first time, you are likely to receive the error:
If when building the project you receive the error:

```
Unable to find manifest signing certificate in the certificate store.
```

There are (at least) two ways to get beyond this problem during development:
You may have enabled manifest signing without having created the
proper certificate. See below for ways to address this error,
involving alternatives such as creating your own certificate, or
to leave signing disabled.

### Use Your Own "Test Certificate"

Expand Down
10 changes: 9 additions & 1 deletion README-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,12 @@ file extension.
named `PilotPathRecorder.exe`, which you'll find within the unzipped
folder. It can be helpful to create a link to this location (e.g.,
on your desktop) for easier access.


> _NOTE: as of this writing, the releases are not "signed", meaning
you will likely receive a message from Windows advising you to
refrain from unzipping and/or running the application, as it doesn't
come from a "trusted" source. Rest assured, there is no malware
included; you can override the warning and continue to install
and run the application, taking comfort that the full source code
and [automated build script](.github/workflows/build.yml) are
provided for [each release](https://github.com/noodnik2/MSFS2020-PilotPathRecorder/releases)._

0 comments on commit 4ea6427

Please sign in to comment.