Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #156

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
# AutoOrtho - Automatic orthophotos for X-Plane
# AutoOrtho - Automatic orthophotos for X-Plane 11& 12

Orthophoto satellite imagery is something that has been supported by X-Plane
for some time. However, this requires a large commitment of storage
space and patience since imagery would need to be downloaded and prepared
space and patience since high-resolution imagery would need to be downloaded and prepared
ahead of time.

This project provides a way to retrieve only the satellite imagery you need as you fly,
wherever you choose to in the world!

[![Video](https://img.youtube.com/vi/seuguds8GX0/hqdefault.jpg)](https://www.youtube.com/watch?v=seuguds8GX0)

* Documentation: (https://kubilus1.github.io/autoortho/)
## Current Version Software Characteristics
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this should go in with the docs dir, not here. Maybe add to docs/index.md.

* Does not remove cached high-res downloaded image automatically, these files can get very large(>100GB) overtime and require manual intervention to delete. (Stored in orthocache folder in the same directory as the .exe executable)
kubilus1 marked this conversation as resolved.
Show resolved Hide resolved
* Hence, if you fly through the same place without deleting you cache, the previously cached file will be accessed again without any downloads
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Hence, if you fly through the same place without deleting you cache, the previously cached file will be accessed again without any downloads
* It is recommended, however, to not cleanup satellite imagery cache too often as that can effect performance and increase strain on servers.

* Unfinished downloads are store in (C:\Users\username\.autoortho-data/downloads) folder by default
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a cross platform project, so references to 'C:' drive should be avoided.

* The console output log is stored in (C:\Users\username\.autoortho-data/)
* The configuration file, (.autoortho) is stored as a independent file in (C:\Users\username\.autoortho-data)

## Links for more information on
* Documentation & Steps to Install: (https://kubilus1.github.io/autoortho/)
* FAQ: (https://kubilus1.github.io/autoortho/faq/)
* Discussions and help: (https://github.com/kubilus1/autoortho/discussions)
* Latest release: (https://github.com/kubilus1/autoortho/releases/latest)
* X-plane.org: (https://github.com/kubilus1/autoortho)

# As seen in
[Swiss001:X-Plane Now Has Worldwide Satellite Scenery STREAMING](https://www.youtube.com/watch?v=qTbBCW2xZRg&t=1sg)