Git Product home page Git Product logo

Comments (8)

aknoerig avatar aknoerig commented on August 9, 2024

Great, good idea. :) It would also be nice to add a minimal example: command line calls together with a sample brd and params. This way it will be much easier for people to get started.

from eagle2fritzing.

s-kostyuk avatar s-kostyuk commented on August 9, 2024

I'll try to add examples after finishing of a translation.

I have a question about "description files". How to write them, what they exactly contain? Can you explain it and provide some example? As an example I mean a zip-archive which contain the whole working folder with source (.brd), config (.params, desctription files and so on with maximum of information in each file) and result (.fzp, .svg) files in it. This will be great for further translation and improving of a readme.

from eagle2fritzing.

aknoerig avatar aknoerig commented on August 9, 2024

The description file should contain the textual description of the part, so a free-form, human-readable text. It appears when hovering over the part in the parts bin, see this example:
bildschirmfoto 2015-08-15 um 15 45 57

For the example, maybe simply create a subfolder "example" that contains all the necessary files, and a readme that outlines all the steps. This way we can easily update it through git.
Thanks!

from eagle2fritzing.

s-kostyuk avatar s-kostyuk commented on August 9, 2024

"For the example, maybe simply create a subfolder "example" that contains all the necessary files, and a readme that outlines all the steps. This way we can easily update it through git." - This will be great, really.

Thank you for explanation :)

from eagle2fritzing.

s-kostyuk avatar s-kostyuk commented on August 9, 2024

What about URL in metadata.dif? Please, show example feed URL and outline the text block which be extracted and saved as a part description for some random part. I want to understand what exactly brd2svg is looking for and why RSS was used for an extraction of a part description?

from eagle2fritzing.

aknoerig avatar aknoerig commented on August 9, 2024

First of all, every part's metadata contains an optional URL that should point to the part's online documentation.

The script additionally tries to automatically extract a description text from that URL by appending a '.json'. This should work at least with the SparkFun website, e.g. https://www.sparkfun.com/products/13339 and https://www.sparkfun.com/products/13339.json

from eagle2fritzing.

s-kostyuk avatar s-kostyuk commented on August 9, 2024

Understood. Thank you

from eagle2fritzing.

s-kostyuk avatar s-kostyuk commented on August 9, 2024

Closed. Until someone will need this translation

from eagle2fritzing.

Related Issues (19)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.