Suggestion and question

[n8ur]

Hi -- I just used Pinion for the first time and really like it. A suggestion about the documentation -- I had trouble figuring out what the "source" option in the javascript call needed to point to. The docs say "Currently, the only option is source that has to contain a location to the source directory". I didn't know whether "source" meant the location of the kicad files, and it took some experimenting to find out it was just where the pinion files lived. It might be easier for newbies if that were made more clear, and even better, show what the contents of the "resources" directory might look like. (I put everything, including the .js and .css in a "tools" directory under my project, and that worked well.)

Now the question -- you reference putting pinion on a github page. How is that done? Can the README.md file include javascript, or is some other approach required?

Thanks very much for a really cool program!

[yaqwsx]

Hi, I am sorry for missing your issue.

I use the term "source directory" all over the documentation. It is the directory pinion generate produces. I see no point in specifying what it contains, as the user does not create the content and the content might change between versions. Currently, it contains two images and a JSON file.

If you put a piece of javascript code into a README, GitHub won't render it (for security reasons). However, if you run your readme via GitHub pages, then it will be displayed.

[n8ur]

Hi Jan -- No worries abotu the delayed response. I don't think using the term "source directory" is an issue, the thing that confused me maybe seems obvious, but wasn't to me. What wasn't clear was the relationship between the "source directory" and the kicad project directory. At first, I thought the source directory was where the .kicad_pcb file was located -- because in a way, that's also a "source directory". If you added something to the "Building the diagram" section like "The 'source directory' is the output location specified in the 'pinion generate' command, which must be within the document root of the web page in which the diagram will be embedded." that would clear it up. Thanks for clarifying about the README. And, thanks again for creating Pinion -- I'm about to generate my second board diagram. John ----

…

On 9/30/21 2:06 AM, Jan Mrázek wrote: Hi, I am sorry for missing your issue. I use the term "source directory" all over the documentation. It is the directory |pinion generate| produces. I see no point in specifying what it contains, as the user does not create the content and the content might change between versions. Currently, it contains two images and a JSON file. If you put a piece of javascript code into a README, GitHub won't render it (for security reasons). However, if you run your readme via GitHub pages, then it will be displayed. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#24 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADNCPP6IU7RPOACJBK2ZWGLUEP45PANCNFSM5DFHPB4Q>. Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.