librepcb-doc

librepcb-doc copied to clipboard

Most screenshots were created with LibrePCB versions much older than the official 0.1.0 release, thus some of the screenshots are outdated.

In addition, we should check if the elements visible in the screenshots do actually correspond to our library conventions (which are still work in progress). It's annoying for users to see screenshots which do not follow our library conventions.

Specific issues:

• Component wizard shows "IC" as prefix for an OpAmp, while we actually use "U" for ICs.
• Component wizard shows "{{PARTNUMBER}}" as default value, while it should be "{{PARTNUMBER or DEVICE}}".

Pardon my ignorance -- does the app itself contain any automation features that could be used to manipulate the app into a particular state, then screenshot the window -- ideally without human intervention? Perhaps something like https://blog.codeship.com/automating-screenshots-in-documentation/ (though that might be mobile-specific).

Does there exist any meta-documentation on how screenshots are being captured/managed/tracked at present? Thx.

The functional test framework (funq) that we already use for tests could be used for that. I'm not sure whether it already has a screenshotting function though. But I guess it could be done directly through Python.

I stored the workspace containing the example libraries and projects in the directory resources/workspace/, so at least the data to reproduce screenshots is available.

But there is no automation yet. It would be really awesome to create a Python script which automatically creates all screenshots with Funq, as suggested by @dbrgn! You can take a look at our functional tests to see how it works.

PR very welcome :)

Another thing that just had me confused for a little while trying to learn LibrePCB was that the screenshots have "required" signals and current LibrePCB has "optional" signals, which is the inverse logic.

LibreCAD

LibrePCB or LibreCAD? They're two different projects.

Whoops, sorry, this is going to be tripping me up for a while to come. Comment edited.