noisymime
/
Arduino
mirror of https://github.com/noisymime/Arduino.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Automatically create sketchbook libraries/ folder and readme (Paul Stoffregen and Limor Fried). 

http://code.google.com/p/arduino/issues/detail?id=986
This commit is contained in:
David A. Mellis 2012-07-19 10:03:39 -04:00
parent 9d21154ea2
commit 4e657ba5e2
1 changed files with 76 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
app/src/processing/app/Base.java
View File

@ -1568,7 +1568,82 @@ public class Base {
static public File getSketchbookLibrariesFolder() {
return new File(getSketchbookFolder(), "libraries");
File libdir = new File(getSketchbookFolder(), "libraries");
if (!libdir.exists()) {
try {
libdir.mkdirs();
File readme = new File(libdir, "readme.txt");
FileWriter freadme = new FileWriter(readme);
freadme.write(_(
"Installing Additional Arduino Libraries\n" +
"----------------------------------------\n" +
"Once you are comfortable with the Arduino software and using the\n" +
"built-in functions, you may want to extend the ability of your Arduino\n" +
"with additional libraries.\n" +
"\n" +
"What are Libraries?\n" +
"----------------------------------------\n" +
"Libraries are a collection of code that makes it easy for you to connect \n" +
"to a sensor, display, module, etc. For example, the built-in \n" +
"LiquidCrystal library makes it easy to talk to character LCD displays. \n" +
"There are hundreds of additional libraries available on the Internet for \n" +
"download. The built-in libraries and some of these additional libraries\n" +
"are listed here: http://arduino.cc/en/Reference/Libraries. To use the\n" +
"additional libraries, you will need to install them.\n" +
"\n" +
"How to Install a Library\n" +
"----------------------------------------\n" +
"Libraries are often distributed as a ZIP file or folder. The name of the \n" +
"folder is the name of the library. Inside the folder will be a .cpp \n" +
"file, a .h file and often a keywords.txt file, examples folder, and other\n" +
"files required by the library.\n" +
"\n" +
"To install the library, first quit the Arduino application.\n" +
"\n" +
"Then uncompress the ZIP file containing the library. For example, if\n" +
"you're installing a library called \"ArduinoParty\", uncompress\n" +
"ArduinoParty.zip. It should contain a folder called ArduinoParty, with\n" +
"files like ArduinoParty.cpp and ArduinoParty.h inside. (If the .cpp and\n" +
".h files aren't in a folder, you'll need to create one. In this case,\n" +
"you'd make a folder called \"ArduinoParty\" and move into it all the files\n" +
"that were in the ZIP file, like ArduinoParty.cpp and ArduinoParty.h.) \n" +
"\n" +
"Drag the ArduinoParty folder into this folder (your libraries folder).\n" +
"Under Windows, it will likely be called \"My Documents\\Arduino\\libraries\".\n" +
"For Mac users, it will likely be called \"Documents/Arduino/libraries\".\n" +
"On Linux, it will be the \"libraries\" folder in your sketchbook.\n" +
"\n" +
"Your Arduino library folder should now look like this (on Windows):\n" +
" My Documents\\Arduino\\libraries\\ArduinoParty\\ArduinoParty.cpp\n" +
" My Documents\\Arduino\\libraries\\ArduinoParty\\ArduinoParty.h\n" +
" My Documents\\Arduino\\libraries\\ArduinoParty\\examples\n" +
" ....\n" +
"or like this (on Mac):\n" +
" Documents/Arduino/libraries/ArduinoParty/ArduinoParty.cpp\n" +
" Documents/Arduino/libraries/ArduinoParty/ArduinoParty.h\n" +
" Documents/Arduino/libraries/ArduinoParty/examples\n" +
" ...\n" +
"or similarly for Linux.\n" +
"\n" +
"There may be more files than just the .cpp and .h files, just make sure \n" +
"they're all there.\n" +
"\n" +
"(The library won't work if you put the .cpp and .h files directly into\n" +
"the libraries folder or if they're nested in an extra folder. For \n" +
"example:\n" +
" Documents\\Arduino\\libraries\\ArduinoParty.cpp and\n" +
" Documents\\Arduino\\libraries\\ArduinoParty\\ArduinoParty\\ArduinoParty.cpp\n" +
"won't work.)\n" +
"\n" +
"Restart the Arduino application. Make sure the new library appears in the \n" +
"Sketch->Import Library menu item of the software.\n" +
"\n" +
"That's it! You've installed a library!\n"));
freadme.close();
} catch (Exception e) {
}
}
return libdir;
}