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

feat: add product tutorial #311

Closed
wants to merge 1 commit into from

Conversation

CBID2
Copy link

@CBID2 CBID2 commented Aug 25, 2023

Description

This PR provides a step-by-step tutorial on how to create a GIF using GIFSki.

Benefit

This will aid new users on how to effectively use this product.

Related Issues

Closes #309

Note to Reviewers
This is the first time I created a product tutorial, so your feedback would be helpful @kornelski! :)

@NotOfficer
Copy link

I dont wanna sound rude but the app is very self explaining.
This seems kinda out of place to me but opinions are different.

@CBID2
Copy link
Author

CBID2 commented Aug 28, 2023

I dont wanna sound rude but the app is very self explaining.

This seems kinda out of place to me but opinions are different.

Hi @NotOfficer. I struggled with using GIFSKI when I first used it, so I decided to add this page so other new users won't experience the same thing. Sometimes, the obvious things aren't so obvious.

@kornelski
Copy link
Member

Thank you for your work on this. However, there's been a bit of a misunderstanding. This particular repository is for the underlying library and a command-line tool, not the macOS app in the video. The app has been developed by somebody else.

Also I did not expect the docs in the form of a video. Git repositories are technically a poor fit for storing large binary files like videos.

@CBID2
Copy link
Author

CBID2 commented Aug 31, 2023

Thank you for your work on this. However, there's been a bit of a misunderstanding. This particular repository is for the underlying library and a command-line tool, not the macOS app in the video. The app has been developed by somebody else.

Also I did not expect the docs in the form of a video. Git repositories are technically a poor fit for storing large binary files like videos.

Hi @kornelski! 😄 Thanks for clarifying about the repository. I really thought this was where the app is hosted. 🤦🏾‍♀️ Also, my original plan was to use GIFs but I heard through a few experienced OS developers that GIFs aren’t the best when using tutorials for accessibility reasons. However, I’m willing to make the necessary changes. 👍🏾

@kornelski
Copy link
Member

There is an irony that GIFs aren't a good format, even for a GIF-making tool.

The repository for the Mac app is here: https://github.com/sindresorhus/Gifski

Note that its website and readme already have images showing the steps. Sindre may like the particular design and wallpaper used in the images. I think the simplest and least controversial thing you can do is to add text description for each of the existing image steps in the readme, explaining what to do exactly.

@CBID2
Copy link
Author

CBID2 commented Sep 5, 2023

Thanks @kornelski! :)

@kornelski kornelski closed this Sep 9, 2023
@CBID2 CBID2 deleted the adding-product-tutorial branch September 9, 2023 15:28
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.

Docs: Product Tutorial
3 participants