starred/ScreenToGif

Fork 0

mirror of https://github.com/NickeManarin/ScreenToGif.git synced 2026-04-25 23:25:52 +03:00

[GH-ISSUE #303] Developer Documentation #250

New issue

Open

opened 2026-02-26 09:30:44 +03:00 by kerem · 8 comments

kerem commented

2026-02-26 09:30:44 +03:00

Owner

Originally created by @nguyenlamlll on GitHub (Mar 23, 2018).
Original GitHub issue: https://github.com/NickeManarin/ScreenToGif/issues/303

Originally assigned to: @nguyenlamlll on GitHub.

Hi,
I have recently looked into the source code. It's a bit... big and to be honest, I'm pretty clueless.

Is there a developer documentation somewhere? Maybe I missed it. I looked in Wiki section but it isn't there. If not, I'd love to help. (And probably need some helps to get starting as well). The documentation may include these sections: What modules and components are there? What are their uses? What are the controls? At least we can get some starting points or an overview look of the whole project.

Originally created by @nguyenlamlll on GitHub (Mar 23, 2018). Original GitHub issue: https://github.com/NickeManarin/ScreenToGif/issues/303 Originally assigned to: @nguyenlamlll on GitHub. Hi, I have recently looked into the source code. It's a bit... big and to be honest, I'm pretty clueless. Is there a developer documentation somewhere? Maybe I missed it. I looked in Wiki section but it isn't there. If not, I'd love to help. (And probably need some helps to get starting as well). The documentation may include these sections: What modules and components are there? What are their uses? What are the controls? At least we can get some starting points or an overview look of the whole project.

kerem added the

🔷Enhancement

label

2026-02-26 09:30:44 +03:00

kerem commented

2026-02-26 09:30:44 +03:00

Author

Owner

@laiqun commented on GitHub (Mar 24, 2018):

just read the source code

@laiqun commented on GitHub (Mar 24, 2018): just read the source code

kerem commented

2026-02-26 09:30:44 +03:00

Author

Owner

@nguyenlamlll commented on GitHub (Mar 24, 2018):

@laiqun Hey man, of course, I know how to read. And the contributors made a really great job keeping the project readable. But I'm talking about the possibility to have a unified documentation where we can levitate newcomers' experiences.

For example, It goes like:

Windows folder hold the UI pages and windows. This .xaml file is that, and that file is something else.

The Util folder mainly contains these stuff. File A does this. (Explain). FIle B does this, and it needs revising. Etc.

@nguyenlamlll commented on GitHub (Mar 24, 2018): @laiqun Hey man, of course, I know how to read. And the contributors made a really great job keeping the project readable. But I'm talking about the possibility to have a unified documentation where we can levitate newcomers' experiences. For example, It goes like: > - Windows folder hold the UI pages and windows. This .xaml file is that, and that file is something else. > - The Util folder mainly contains these stuff. File A does this. (Explain). FIle B does this, and it needs revising. Etc.

kerem commented

2026-02-26 09:30:44 +03:00

Author

Owner

@NickeManarin commented on GitHub (Mar 24, 2018):

@laiqun You are not being helpful.

@nguyenlamlll

Is there a developer documentation somewhere?

No, there's no documentation. :/

I looked in Wiki section but it isn't there.

Yeah, the wiki contains only a guide for translators and users (this one is incomplete).

If not, I'd love to help. (And probably need some helps to get starting as well)

That would be awesome! I'll explain everything that you need to know.

@NickeManarin commented on GitHub (Mar 24, 2018): @laiqun You are not being helpful. @nguyenlamlll > Is there a developer documentation somewhere? No, there's no documentation. :/ > I looked in Wiki section but it isn't there. Yeah, the wiki contains only a guide for translators and users (this one is incomplete). > If not, I'd love to help. (And probably need some helps to get starting as well) That would be awesome! I'll explain everything that you need to know.

kerem commented

2026-02-26 09:30:44 +03:00

Author

Owner

@laiqun commented on GitHub (Mar 24, 2018):

@nguyenlamlll
After reading the source code of Author,I write some note, but only cover some part of source code.
If you like to reading it ,I will upload it for help you .

@laiqun commented on GitHub (Mar 24, 2018): @nguyenlamlll After reading the source code of Author,I write some note, but only cover some part of source code. If you like to reading it ,I will upload it for help you .

kerem commented

2026-02-26 09:30:44 +03:00

Author

Owner

@nguyenlamlll commented on GitHub (Mar 25, 2018):

@NickeManarin What format would you like and where should they be hosted? Wiki pages on Github are not so great in my opinion. One should be invited as a contributor to edit the pages, right? Or can we update the docs on the website repository? So later, we can access it like screentogif.com/docs, for example.

@nguyenlamlll commented on GitHub (Mar 25, 2018): @NickeManarin What format would you like and where should they be hosted? Wiki pages on Github are not so great in my opinion. One should be invited as a contributor to edit the pages, right? Or can we update the docs on the website repository? So later, we can access it like `screentogif.com/docs`, for example.

kerem commented

2026-02-26 09:30:44 +03:00

Author

Owner

@NickeManarin commented on GitHub (Mar 26, 2018):

For a developer documentation, it would be better to stay here, on GitHub (because the code is located in here).

@NickeManarin commented on GitHub (Mar 26, 2018): For a developer documentation, it would be better to stay here, on GitHub (because the code is located in here).

kerem commented

2026-02-26 09:30:44 +03:00

Author

Owner

@nguyenlamlll commented on GitHub (Mar 27, 2018):

So a folder /Docs at the root with markdown files inside. Sounds good?
Do you use any other chat tools? I think I can start working on it now and well, gonna have quite a few of quick questions.

@nguyenlamlll commented on GitHub (Mar 27, 2018): So a folder `/Docs` at the root with markdown files inside. Sounds good? Do you use any other chat tools? I think I can start working on it now and well, gonna have quite a few of quick questions.

kerem commented

2026-02-26 09:30:44 +03:00

Author

Owner

@NickeManarin commented on GitHub (Mar 27, 2018):

So a folder /Docs at the root with markdown files inside. Sounds good?

Yes :)

Do you use any other chat tools?

Yes: Email, Discord, Twitter.

http://www.screentogif.com/contact

@NickeManarin commented on GitHub (Mar 27, 2018): > So a folder /Docs at the root with markdown files inside. Sounds good? Yes :) >Do you use any other chat tools? Yes: Email, Discord, Twitter. http://www.screentogif.com/contact

kerem referenced this issue

2026-03-01 18:46:36 +03:00

[GH-ISSUE #250] [Feature request] Multi-core processing for save-processing of animations #1574

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/ScreenToGif#250

No description provided.

Rows
Columns