mriale / PyDPainter

A usable pixel art paint program written in Python
GNU General Public License v3.0
544 stars 26 forks source link

Tools options doc #121

Closed Sleuthgame closed 1 month ago

Sleuthgame commented 7 months ago

Tools bar is documented as a png and PDF but tools options are missing (spacing, filling, etc).

Sleuthgame commented 7 months ago

I began writing and illustrating this. Will be a tools.md and then, fill type and spacing will have their own explanation page.

Sleuthgame commented 3 months ago

UPDATE: I have done the complete structure for this : tool list, with summary, illustrated with the icon and shortcut key. : Then I describe each tool with a illustrated example and some tips. I'm on AREA TOOL. 😭

Sleuthgame commented 3 months ago

Hey, Stephane, you seems to have a lot of nice ideas for new functions involving work for the programmer ! But... How's that part of the doc coming along ?

Sleuthgame commented 3 months ago

I have written it up to Text, included. 6 tools left and I'm done.

Sleuthgame commented 3 months ago

I add my WIP on the develop branch as a backup. The spacing-examples image refuses to display in the spacing.md page. Spacing-examples

mriale commented 3 months ago

The image file name was capitalized, so I capitalized the reference to it. 7e2c9c1dbd384dc2d8077cb685afca970624aea1

I haven't done any other proofreading yet.

Sleuthgame commented 3 months ago

Thanks. I'll try to finish the tools list today.

Sleuthgame commented 3 months ago

It's done. You can start proofreading.

Fill type will have its own .md, because the tool page is long enough and there are a lot to explain.

mriale commented 3 months ago

@Sleuthgame This is amazing all the work you've done on this! Thank you so much!

As you can see, I moved all the tools docs into another directory. That makes some of the the cross-links a little weird but makes the images and such more manageable.

I didn't get to editing fill.md yet. I think there are a few missing images there also. I did add links to the page from the toolbox.md page.

Sleuthgame commented 3 months ago

Thank you, that's very kind of you.

I've been struggling to find graphically inspiring examples to give ideas. Some of the functions are a bit dated, which makes sense.

I've also struggled quite a bit with PydPainter's file request between the dev and releases versions. Amiga assigns or favorites are really missing.

I think I found a few bugs along the way too. When you're systematically testing all the options, it's pretty thankless.

Well, the main thing is that we progress at our own pace. I'll have a look at those missing images. I'd like to add a nice example of symmetry.

mriale commented 3 months ago

@Sleuthgame Another great explanation -- this time fill types! I edited fill.md but noticed that the section about the gradient directions was still not done. I hope I didn't stomp on your edits! I also did some resizing of the images in the markdown to make them a little more consistent.

Sleuthgame commented 3 months ago

I DL your .md file, edit it and gradient direction snapshots are integrated, but I'm not great at explaining the last one. I did the same resizing for the 5 new pictures.

I think we are ok with this part. :-)

Sleuthgame commented 3 months ago

Oh I forgot ! There is a back link to Palette Range to fix because of the new dir.

mriale commented 3 months ago

@Sleuthgame Thanks! Yeah, gradient is a little hard to describe. I edited your work to have a few less words, but I hope it still does it justice. I know French is such a descriptive language, and sometimes Americans are too impatient to read any extra words. :smile:

I also fixed the Range link.

I plan to move these updated docs over to production this weekend so that they show up on the PyDPainter web site.

Sleuthgame commented 3 months ago

ahah, it's quoted from the American DPaint3 manual ! :-))) But in those days, they liked to go into great detail.

Sleuthgame commented 1 month ago

Ok, we are done here.