Improved new-user experience #1718
Conversation
Updated the readme.md file to include links and info relevant to a new-user, or in other words someone who is visiting the github page for the first time.
There was a problem hiding this comment.
Hi Benjiidavidson
Thanks for the contribution to the project, overall I like the idea of placing a showcase reel on our github page too as well as referring to our FAQ and User manual, although they haven't been updated in quite a while. The most recent and up to date FAQ is on our Discord server so maybe mentioning that too would be a good idea.
@Jose-Moreno what do you think?
As commented, I don't quite get why you start the video 17 seconds in, was that deliberate?
README.md
Outdated
| @@ -4,6 +4,8 @@ | |||
|
|
|||
| **Pencil2D** is an animation/drawing software for Windows, macOS, Linux, and FreeBSD. It lets you create traditional hand-drawn animation (cartoon) using both bitmap and vector graphics. Pencil2D is free and open source. | |||
|
|
|||
| Here is a video demonstrating the project: <https://www.youtube.com/watch?v=ma52j9B1kEM&t=17s> | |||
There was a problem hiding this comment.
Any reason this starts 17 seconds in?
There was a problem hiding this comment.
I know a lot of youtube users don't like to see "intros" on their binge-watch content, however since Pencil2D is not a typical "youtuber" channel but a project channel with informative purposes, I think it needs to at least keep the branding, and that's considering that most of our reach is fueled by word-of-mouth and how others show the capabilities of the program, either by doing artwork or tutorials.
README.md
Outdated
| @@ -4,6 +4,8 @@ | |||
|
|
|||
| **Pencil2D** is an animation/drawing software for Windows, macOS, Linux, and FreeBSD. It lets you create traditional hand-drawn animation (cartoon) using both bitmap and vector graphics. Pencil2D is free and open source. | |||
|
|
|||
| Here is a video demonstrating the project: <https://www.youtube.com/watch?v=ma52j9B1kEM&t=17s> | |||
There was a problem hiding this comment.
This should probably be put below the link to the website and rephrased to something more explanatory, for example animation showcase 2020.
@MrStevns Ah sorry I saw this PR and I forgot to reply. Yes I think it's a good thing. I also think It should also be in it's own section similar to the "contributing" section. It could be something like this ### User Showcase
[](https://www.youtube.com/watch?v=ma52j9B1kEM)
_User Showcase Reel 2022_
### Using Pencil2D
* [Quick Reference](https://www.pencil2d.org/doc/quick-reference.html) - Web version of the PDF guide included with Pencil2D
* [User Manual](https://www.pencil2d.org/doc/user-manual.html) - End user documentation how-to
* [FAQ](https://www.pencil2d.org/doc/faq.html) - Frequently Asked Questions
Markdown PreviewUser ShowcaseUser Showcase Reel 2022 Using Pencil2D
Currently the re are some issues that are dependencies for this PR though
I could take on the FAQ and the quick reference, but the manual itself needs a different focus. I'm going to try If that doesn't work I'll look into other apps I have bookmarked. To be honest currently I have no desire to mess with Jekyll and markdown files just to put the manual to work since it's been neglected for so long and it needs to be done even if it's a second draft, plus I want to make a proper layout instead of just showing text. Thank you for reviewing this. |
Alternatively we could simply state that these sections are outdated and require updates, and people are welcome to step in and help. |
|
@MrStevns That's fine by me 👌 Let's wait for OP to reply so we can merge it. If anything I'll send the PR some updates later this week just in case we lost contact with them. |
- Added showcase video
|
I have updated the Readme in the PR with the changes we discussed, @Jose-Moreno do you agree? |
|
@MrStevns Yes. Agreed. We can open individual issues on pencil2d.github.io repo to address your concerns on a previous reply:
|
Updated the readme.md file to include links and info relevant to a new-user, or in other words someone who is visiting the github page for the first time.