From 3278173ef810935e07808deed58783c1bc7ca4cf Mon Sep 17 00:00:00 2001 From: Varshini Shree <117148310+VarshiniShreeV@users.noreply.github.com> Date: Fri, 18 Oct 2024 22:02:19 +0530 Subject: [PATCH] Add note re: Arduino IDE 2.x repo to readme, format readme --- README.md | 90 ++++++++++++++++--------------------------------------- 1 file changed, 26 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index df714ab1e..ab7504dd2 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,59 @@

- +

-Arduino is an open-source physical computing platform based on a simple I/O -board and a development environment that implements the Processing/Wiring -language. Arduino can be used to develop stand-alone interactive objects or -can be connected to software on your computer (e.g. Flash, Processing and MaxMSP). -The boards can be assembled by hand or purchased preassembled; the open-source -IDE can be downloaded for free at [https://arduino.cc](https://www.arduino.cc/en/Main/Software) +**Important Notice**: This repository contains the legacy Arduino IDE 1.x, which is no longer in active development. For the latest features and updates, please visit the [Arduino IDE 2.x](https://github.com/arduino/arduino-ide) repository. If you encounter issues related to the newer IDE, please report them there. + +Arduino is an open-source physical computing platform based on a simple I/O board and a development environment that implements the Processing/Wiring language. Arduino can be used to develop stand-alone interactive objects or can be connected to software on your computer (e.g. Flash, Processing and MaxMSP). The boards can be assembled by hand or purchased preassembled; the open-source IDE can be downloaded for free at [https://arduino.cc](https://www.arduino.cc/en/Main/Software). ![Github](https://img.shields.io/github/v/release/arduino/Arduino) ## More info at -- [Our website](https://www.arduino.cc/) - -- [The forums](https://forum.arduino.cc/) - -- Follow us on [Twitter](https://twitter.com/arduino) -- And like us at [Facebook](https://www.facebook.com/official.arduino) +- [Our website](https://www.arduino.cc/) +- [The forums](https://forum.arduino.cc/) +- Follow us on [Twitter](https://twitter.com/arduino) +- And like us at [Facebook](https://www.facebook.com/official.arduino) ## Bug reports and technical discussions -- To report a *bug* in the software or to request *a simple enhancement* go to [Github Issues](https://github.com/arduino/Arduino/issues) - -- More complex requests and technical discussion should go on the [Arduino Developers -mailing list](https://groups.google.com/a/arduino.cc/forum/#!forum/developers) - -- If you're interested in modifying or extending the Arduino software, we strongly -suggest discussing your ideas on the -[Developers mailing list](https://groups.google.com/a/arduino.cc/forum/#!forum/developers) - *before* starting to work on them. -That way you can coordinate with the Arduino Team and others, -giving your work a higher chance of being integrated into the official release +- To report a *bug* in the software or to request *a simple enhancement*, go to [Github Issues](https://github.com/arduino/Arduino/issues). +- More complex requests and technical discussions should go on the [Arduino Developers mailing list](https://groups.google.com/a/arduino.cc/forum/#!forum/developers). +- If you're interested in modifying or extending the Arduino software, we strongly suggest discussing your ideas on the [Developers mailing list](https://groups.google.com/a/arduino.cc/forum/#!forum/developers) *before* starting to work on them. That way you can coordinate with the Arduino Team and others, giving your work a higher chance of being integrated into the official release. ### Security -If you think you found a vulnerability or other security-related bug in this project, please read our -[security policy](https://github.com/arduino/Arduino/security/policy) and report the bug to our Security Team 🛡️ -Thank you! +If you think you found a vulnerability or other security-related bug in this project, please read our [security policy](https://github.com/arduino/Arduino/security/policy) and report the bug to our Security Team 🛡️. Thank you! e-mail contact: security@arduino.cc ## Installation -Detailed instructions for installation in popular operating systems can be found at: +Detailed instructions for installation on popular operating systems can be found at: -- [Linux](https://www.arduino.cc/en/Guide/Linux) (see also the [Arduino playground](https://playground.arduino.cc/Learning/Linux)) -- [macOS](https://www.arduino.cc/en/Guide/macOS) -- [Windows](https://www.arduino.cc/en/Guide/Windows) +- [Linux](https://www.arduino.cc/en/Guide/Linux) (see also the [Arduino playground](https://playground.arduino.cc/Learning/Linux)) +- [macOS](https://www.arduino.cc/en/Guide/macOS) +- [Windows](https://www.arduino.cc/en/Guide/Windows) ## Contents of this repository -This repository contains just the code for the Arduino IDE itself. -Originally, it also contained the AVR and SAM Arduino core and libraries -(i.e. the code that is compiled as part of a sketch and runs on the -actual Arduino device), but those have been moved into their own -repositories. They are still automatically downloaded as part of the -build process and included in built releases, though. +This repository contains just the code for the Arduino IDE itself. Originally, it also contained the AVR and SAM Arduino core and libraries (i.e. the code that is compiled as part of a sketch and runs on the actual Arduino device), but those have been moved into their own repositories. They are still automatically downloaded as part of the build process and included in built releases, though. The repositories for these extra parts can be found here: -- Non-core specific Libraries are listed under: - (and also a few other places, see `build/build.xml`). - -- The AVR core can be found at: - -- Other cores are not included by default but installed through the - board manager. Their repositories can also be found under - . +- Non-core specific Libraries are listed under: [Arduino Libraries](https://github.com/arduino-libraries/) (and also a few other places, see `build/build.xml`). +- The AVR core can be found at: [ArduinoCore-avr](https://github.com/arduino/ArduinoCore-avr). +- Other cores are not included by default but can be installed through the board manager. Their repositories can also be found under [Arduino GitHub organization](https://github.com/arduino/). ## Building and testing -Instructions for building the IDE and running unit tests can be found on -the wiki: -- -- +Instructions for building the IDE and running unit tests can be found on the wiki: +- [Building Arduino](https://github.com/arduino/Arduino/wiki/Building-Arduino) +- [Testing Arduino](https://github.com/arduino/Arduino/wiki/Testing-Arduino) ## Credits -Arduino is an open source project, supported by many. +Arduino is an open-source project, supported by many. The Arduino team is composed of Massimo Banzi, David Cuartielles, Tom Igoe, and David A. Mellis. -The Arduino team is composed of Massimo Banzi, David Cuartielles, Tom Igoe -and David A. Mellis. - -Arduino uses -[GNU avr-gcc toolchain](https://gcc.gnu.org/wiki/avr-gcc), -[GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), -[avr-libc](https://www.nongnu.org/avr-libc/), -[avrdude](https://www.nongnu.org/avrdude/), -[bossac](http://www.shumatech.com/web/products/bossa), -[openOCD](http://openocd.org/) -and code from [Processing](https://www.processing.org) -and [Wiring](http://wiring.org.co). - -Icon and about image designed by [ToDo](https://www.todo.to.it/) +Arduino uses [GNU avr-gcc toolchain](https://gcc.gnu.org/wiki/avr-gcc), [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), [avr-libc](https://www.nongnu.org/avr-libc/), [avrdude](https://www.nongnu.org/avrdude/), [bossac](http://www.shumatech.com/web/products/bossa), [openOCD](http://openocd.org/), and code from [Processing](https://www.processing.org) and [Wiring](http://wiring.org.co). +Icon and about image designed by [ToDo](https://www.todo.to.it/).