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

add some more documentation to timelapse.sh #672

Merged
merged 2 commits into from
Oct 16, 2021
Merged

add some more documentation to timelapse.sh #672

merged 2 commits into from
Oct 16, 2021

Conversation

ckuethe
Copy link
Collaborator

@ckuethe ckuethe commented Oct 16, 2021

Make it easier to run timelapse.sh -h without a valid configuration to
figure out what this script does and how to use it, especially manually.

$ ./scripts/timelapse.sh -h
Usage: timelapse.sh [-h|--help] <DATE> [<IMAGE_DIR>]
    example: timelapse.sh 20211016
    or:      timelapse.sh 20211016 /media/external/allsky

<DATE> must be of the form YYYYMMDD.

<IMAGE_DIR> defaults to '${ALLSKY_IMAGES}', but may be overriden. In that case
<DATE> must exist inside <IMAGE_DIR>, eg. '/media/external/allsky/20211016'.

Produces a movie in <IMAGE_DIR>/<DATE>/allsky-<DATE>.mp4
eg. /home/ckuethe/allsky/images/20211016/allsky-20211016.mp4
or  /media/external/allsky/20211016/allsky-20211016.mp4

Make it easier to run `timelapse.sh -h` without a valid configuration to
figure out what this script does and how to use it, especially manually.
@linuxkidd linuxkidd merged commit fad7883 into AllskyTeam:master Oct 16, 2021
@ckuethe ckuethe deleted the document_timelapse branch October 16, 2021 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants