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

The instructions for the installation of the extension are ambiguous #30

Open
PiorGit opened this issue Aug 8, 2023 · 2 comments
Open

Comments

@PiorGit
Copy link

PiorGit commented Aug 8, 2023

The provided instructions are ambiguous.

"To install a new extension, download and unpack the archive file. Copy the files into the directory listed at Edit > Preferences > System: User extensions. Be sure to copy the *.py, *.pyc and *.inx files from inkscape driver directly to this folder. After a restart of Inkscape, the new extension will be available."

Instead of the above, the instructions should clearly describe the proper expected hierarchy and should mention the actual folder names instead of "this folder". This is especially important since downloading the zip from git results in a 4xidraw-master.zip file containing a 4xidraw-master folder.

The foolproof way to achieve the above is simply to provide screenshots from the Inkscape extensions folder, showing all the relevant files and hierarchy. And ideally, providing a dedicated download with only the necessary and sufficient files, as opposed to the automatically packed "-master" zip.

@PiorGit
Copy link
Author

PiorGit commented Aug 8, 2023

Here's an example showing what I believe to be the necessary and sufficient setup :

axidraw extension

That way there is no guesswork involved, and no assumptions made what the user knows or doesn't know about Git in general and Inkscape extensions in particular.

@PiorGit
Copy link
Author

PiorGit commented Aug 8, 2023

Lastly the following mention is unclear, as nowhere does it say if these are dependencies, or simply credit being given.

2023-08-08 12_29_16-bullestock_4xidraw_ Software for the AxiDraw drawing machine

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

No branches or pull requests

1 participant