Coder Social home page Coder Social logo

Comments (4)

MajicDesigns avatar MajicDesigns commented on May 28, 2024

One of the reasons for moving the repo to GitHub is to include it in the IDE library manager, so that is in the plans for the near future.

Install instructions are a good idea and I'll do something, but the biggest issue I find is that a substantial minority do not read any documentation - they just 'load and go'. Not sure how o get the message to that subset. Automatic installation from the IDE is not going to help this as you don't even get to see the readme unless you make an effort, which they don't.

from md_parola.

bperrybap avatar bperrybap commented on May 28, 2024

I have the same issue with some of my libraries.
But at least with install instructions in the readme for the repo you can provide a link to them that gets them to the repo where they can read how to install it using the library manager.
There are still quite a few Arduino users that have no idea that the library manger even exists.
It can also help for those that might stumble across the repo using a google search.

Also one thing that can help is if the example sketches have a web link in them that points to repo and potentially a place to find any documentation.
That way once the library is installed, there are always links being put in front of them of where to find additional information. And with newer IDEs they can click on the links and bring up a browser directly from the IDE.

Recently, I've starting taking bit harder approach and simply not helping those very much that either won't or refuse to read the documentation. I'll politely point them to the documentation.
Either they finally read it or give up. Not sure but either way, the amount of silly follow questions has dramatically reduced.

--- bill

from md_parola.

MajicDesigns avatar MajicDesigns commented on May 28, 2024

Libraries have been added to the download manager. Additional comments have been put in the MD_Parola example files. Thanks for the suggestion.

from md_parola.

bperrybap avatar bperrybap commented on May 28, 2024

One thing to consider with direct links to documentation in the examples, is that examples may end up pointing to updated documentation that is not applicable to the version of the library installed.
I have a similar issue in my libraries.
I'm considering having a different documentation directory for each library version and then having a fixup script that goes in and patches all the examples to point to the correct location for that version of the library.
In my case I already have some fixup scripts that patch things like library version information in various files and this would be just another fixup.

There is no easy solution for handling per revision documentation.

from md_parola.

Related Issues (20)

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.