From 100f202eb9ccac86614b540bc48c82b49cad0541 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sat, 28 Apr 2018 23:41:17 -0700 Subject: [PATCH] Move library to root of repository A popular library installation technique is to download the library via GitHub's Clone or download > Download ZIP and then use the Arduino IDE's Sketch > Include Library > Add .ZIP Library. This requires the library to be in the root of the repository, not in a subfolder. If the library is not in the root of the repository this installation technique fails: Specified folder/zip file does not contain a valid library This move is also required if you wanted to add your library to the Arduino Library Manager index, which provides an even easier installation option. --- README.md | 23 ++++++++++++++++ StepperWidle/README.adoc | 26 ------------------- StepperWidle/keywords.txt => keywords.txt | 0 .../library.properties => library.properties | 0 {StepperWidle/src => src}/StepperWidle.cpp | 0 {StepperWidle/src => src}/StepperWidle.h | 0 6 files changed, 23 insertions(+), 26 deletions(-) delete mode 100644 StepperWidle/README.adoc rename StepperWidle/keywords.txt => keywords.txt (100%) rename StepperWidle/library.properties => library.properties (100%) rename {StepperWidle/src => src}/StepperWidle.cpp (100%) rename {StepperWidle/src => src}/StepperWidle.h (100%) diff --git a/README.md b/README.md index 5e1f0f9..9958d1b 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ Update to the stepper library that includes the method idle() to power down the I've added the method idle() to the stepper library (library source attached to this message). This method powers down the stepper motor for power saving or allow it to be freely rotated manually. +This library allows you to control unipolar or bipolar stepper motors. To use it you will need a stepper motor, and the appropriate hardware to control it. + sample code: #include @@ -14,3 +16,24 @@ myStepper.idle(); //Power down stepper delay(5000); myStepper.step(50); //step another 50 steps + + +== License == + +Copyright (c) Arduino LLC. All right reserved. +Copyright (c) Sebastian Gassner. All right reserved. +Copyright (c) Noah Shibley. All right reserved. + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/StepperWidle/README.adoc b/StepperWidle/README.adoc deleted file mode 100644 index 9d4d052..0000000 --- a/StepperWidle/README.adoc +++ /dev/null @@ -1,26 +0,0 @@ -= Stepper Library for Arduino = - -This library allows you to control unipolar or bipolar stepper motors. To use it you will need a stepper motor, and the appropriate hardware to control it. - -For more information about this library please visit us at -http://www.arduino.cc/en/Reference/Stepper - -== License == - -Copyright (c) Arduino LLC. All right reserved. -Copyright (c) Sebastian Gassner. All right reserved. -Copyright (c) Noah Shibley. All right reserved. - -This library is free software; you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public -License as published by the Free Software Foundation; either -version 2.1 of the License, or (at your option) any later version. - -This library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. - -You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/StepperWidle/keywords.txt b/keywords.txt similarity index 100% rename from StepperWidle/keywords.txt rename to keywords.txt diff --git a/StepperWidle/library.properties b/library.properties similarity index 100% rename from StepperWidle/library.properties rename to library.properties diff --git a/StepperWidle/src/StepperWidle.cpp b/src/StepperWidle.cpp similarity index 100% rename from StepperWidle/src/StepperWidle.cpp rename to src/StepperWidle.cpp diff --git a/StepperWidle/src/StepperWidle.h b/src/StepperWidle.h similarity index 100% rename from StepperWidle/src/StepperWidle.h rename to src/StepperWidle.h