search

andyvand / arduino

Automatically exported from code.google.com/p/arduino
Other
0 stars 0 forks source link

Auto-creation of 'libraries' subfolder and readme in the sketchbook. #986

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
What change would like to see?
-------------------------------
Creating the "libraries" subfolder in the arduino sketch folder as well as a 
basic readme explaining how to install libaries

Why?
----
It would make it easier for customers to extend their arduino project with 
sensors, motors, etc.

Would this cause any incompatibilities with previous versions?  If so, how
can these be mitigated?
------------------------
none

Original issue reported on code.google.com by lady...@gmail.com on 17 Jul 2012 at 5:22

GoogleCodeExporter commented 9 years ago 
Here's the patch.

Original comment by paul.sto...@gmail.com on 17 Jul 2012 at 5:25

Attachments:

GoogleCodeExporter commented 9 years ago 
Change text to:

Installing Additional Arduino Libraries
----------------------------------------
Once you are comfortable with the Arduino IDE and using the built-in
functions, you may want to extend the ability of your Arduino with 
additional Libraries.

What are Libraries?
----------------------------------------
Libraries are a collection of code that makes it easy for you to connect 
to a sensor, display, module, etc. For example, the built-in 
LiquidCrystal library makes it easy to talk to character LCD displays. 
There are hundreds of additional libraries available on the Internet for 
download. To use them, you will need to install them.

How to install a Library
----------------------------------------
Libraries are often distributed as a ZIP file or folder. The name of the 
folder is the name of the library. Inside the folder will be a .cpp 
file, a .h file and often times a keywords.txt file, examples folder and 
other files required by the library.

To install the library, first quit the Arduino IDE.

Uncompress the downloaded folder. For example if we are installing a 
library called "ArduinoParty". Uncompress ArduinoParty.zip into a new 
folder. Inside the new folder there should be a file called 
ArduinoParty.cpp and ArduinoParty.h.

Rename the new folder ArduinoParty to match the base name of the .cpp 
and .h files.

Drag the ArduinoParty folder into this folder.
Under Windows it will likely be called "My Documents\Arduino\libraries".
For Mac users it will likely be called "Documents/arduino/libraries"
Your Arduino library folder should now look like this:
    My Documents\Arduino\libraries\ArduinoParty\ArduinoParty.cpp
    My Documents\Arduino\libraries\ArduinoParty\ArduinoParty.h
    My Documents\Arduino\libraries\ArduinoParty\examples
    ....
or like this:
    Documents/arduino/libraries\ArduinoParty\ArduinoParty.cpp
    Documents/arduino/libraries\ArduinoParty\ArduinoParty.h
    Documents/arduino/libraries\ArduinoParty\examples
    ...
There may be more files than just the .cpp and .h files, just make sure 
they're all there

Restart the Arduino IDE. Make sure the new library appears in the 
Sketch->Import Library menu item of the IDE.

That's it! You've installed a library!

For more information, check out
http://www.arduino.cc/en/Hacking/Libraries

Original comment by lady...@gmail.com on 17 Jul 2012 at 5:44

GoogleCodeExporter commented 9 years ago 
https://github.com/arduino/Arduino/commit/4e657ba5e20329c01304b0bb7c5b29f015ae41
95

Original comment by dmel...@gmail.com on 19 Jul 2012 at 2:06

GoogleCodeExporter commented 9 years ago 
Issue 202 has been merged into this issue.

Original comment by dmel...@gmail.com on 19 Jul 2012 at 2:29