Skip to content

Commit

Permalink
chore: Update file paths in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
royshil committed Jun 7, 2024
1 parent b432393 commit 72cb8b0
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Additional guides:

See the [releases](https://github.com/occ-ai/scoresight/releases) page for downloadable executables and installers.

See the [Install Guide](INSTALL.md) for help with installation.
See the [Install Guide](docs/INSTALL.md) for help with installation.

## Running and Building from Source

Expand Down
20 changes: 10 additions & 10 deletions INSTALL.md → docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,54 +6,54 @@ Downloading ScoreSight for your operating system is a simple process. Visit the

If your browser alerts you for a virus warning when downloading ScoreSight like so:

![alt text](docs/image.png)
![alt text](image.png)

This is a false alarm issue by Microsoft and Google. To bypass this alarm and download the file you may need to temporarily disable the Windows Defender that issues the alarm and prevents the file download. This is simple to do, and you can undo it right after downloading ScoreSight to resume protection of your PC.

Open Windows Security by pressing the Windows Key and enter "Windows Security"

![alt text](docs/image-1.png)
![alt text](image-1.png)

Click "App and Browser Control"

![alt text](docs/image-2.png)
![alt text](image-2.png)

Click "Reputation Based protection"

![alt text](docs/image-3.png)
![alt text](image-3.png)

And disable the "Check Apps and Files" and "SmartScreen for Microsoft Edge" options.

![alt text](docs/image-4.png)
![alt text](image-4.png)

Then download ScoreSight again. This time the download should go through and the file will be available on your PC. Re-enable the two options above to resume protecting your computer from malicious software.

If you are having problems with the download still please reach out on [email protected]

To install on Windows, simply click the .zip file and then the .exe setup installer inside.

![alt text](docs/image-5.png)
![alt text](image-5.png)

Once the setup is complete, ScoreSight will be available as an application.

If you get an error of a virus (which is a false alarm) like so

![alt text](docs/image-14.png)
![alt text](image-14.png)

Make sure to disable real-time protection

![alt text](docs/image-15.png)
![alt text](image-15.png)

## Mac OS

On Mac OS ScoreSight comes as packaged .app application which doesn't need installation.

Download the .dmg archive:

![alt text](docs/image-6.png)
![alt text](image-6.png)

Double click and optionally drag the scoresight.app file to your Applications folder:

![alt text](docs/image-7.png)
![alt text](image-7.png)

ScoreSight should now be available as an application.
16 changes: 15 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,18 @@ Additional guides:

See the [releases](https://github.com/occ-ai/scoresight/releases) page for downloadable executables and installers.

See the [Install Guide](../INSTALL.md) for help with installation.
See the [Install Guide](INSTALL.md) for help with installation.

## License

This project is released under the MIT license.

## Contact

If you have any questions or suggestions, feel free to leave an issue on the repository.
You may also email [[email protected]](mailto:[email protected]).

## Business Inquiries

If you wish to contract the development team to productionize ScoreSight for your needs,
please contact [[email protected]](mailto:[email protected]).
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ title: ScoreSight
description: ScoreSight is a powerful real-time OCR application for scoreboards, videos and games
show_downloads: true
email: [email protected]
logo: /docs/logo.png
Binary file added docs/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 72cb8b0

Please sign in to comment.