diff --git a/LICENSE.txt b/LICENSE.txt index a454e8a..01f04d6 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -87,7 +87,6 @@ https://github.com/yyyc514/ArduboyExtra Copyright (c) 2015 Josh Goebel Code for drawing compressed bitmaps: -https://github.com/TEAMarg/drawCompressed Copyright (c) 2016 TEAM a.r.g. Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/README.md b/README.md index 22b37be..12d3666 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ For notes on the differences between the *Arduboy2* library and the original *Ar ## Library documentation -Comments in the library header files are formatted for the [Doxygen](http://www.doxygen.org) document generation system. The HTML files generated using the configuration file _extras/Doxyfile_ can be found at: +Comments in the library header files are formatted for the [Doxygen](https://www.doxygen.nl/) document generation system. The HTML files generated using the configuration file _extras/Doxyfile_ can be found at: https://MLXXXp.github.io/documents/Arduino/libraries/Arduboy2/Doxygen/html/index.html @@ -107,7 +107,7 @@ Sample sketches have been included with the library as examples of how to use it `File > Examples > Arduboy2` -More information on writing sketches for the Arduboy can be found in the [Arduboy Community Forum](http://community.arduboy.com/). +More information on writing sketches for the Arduboy can be found in the [Arduboy Community Forum](https://community.arduboy.com/). ### Using EEPROM in a sketch <- THIS IS IMPORTANT! @@ -147,7 +147,7 @@ If you want to be able to play sequences of tones or background music, using the #### Remove the text functions -If your sketch doesn't use any of the functions for displaying text, such as *setCursor()* and *print()*, you can remove them. You could do this if your sketch generates whatever text it requires by some other means. Removing the text functions frees up code by not including the font table and some code that is always pulled in by inheriting the [Arduino *Print* class](http://playground.arduino.cc/Code/Printclass). +If your sketch doesn't use any of the functions for displaying text, such as *setCursor()* and *print()*, you can remove them. You could do this if your sketch generates whatever text it requires by some other means. Removing the text functions frees up code by not including the font table and some code that is always pulled in by inheriting the [Arduino *Print* class](https://playground.arduino.cc/Code/Printclass/). To eliminate text capability in your sketch, when creating the library object simply use the *Arduboy2Base* class instead of *Arduboy2*: @@ -262,7 +262,7 @@ Main differences between Arduboy2 and Arduboy V1.1 are: - The *beginNoLogo()* function is not included. This function could be used in Arduboy V1.1 in place of *begin()* to suppress the displaying of the ARDUBOY logo and thus free up the code that it required. Instead, Arduboy2 allows a sketch to call *boot()* and then add in any extra features that *begin()* provides by calling their functions directly after *boot()*, if desired. - The *ArduboyCore* and *ArduboyAudio* base classes, previously only available to, and used to derive, the *Arduboy* class, have been made publicly available for the benefit of developers who may wish to use them as the base of an entirely new library. This change doesn't affect the existing API. -As of version 2.1.0 functionality from the [Team A.R.G.](http://www.team-arg.org/) *Arglib* library has been added: +As of version 2.1.0 functionality from the Team A.R.G. *Arglib* library has been added: - The sprite drawing functions, collision detection functions, and button handling functions that Team A.R.G. incorporated from the [ArduboyExtra](https://github.com/yyyc514/ArduboyExtra) project. The *poll()* function was renamed *pollButtons()* for clarity. The *Sprites* class doesn't require a parameter for the constructor, whereas in *Arglib* a pointer to an Arduboy class object is required. - The *drawCompressed()* function, which allows compressed bitmaps to be drawn. Saving bitmaps in compressed form may reduce overall sketch size. diff --git a/extras/docs/FILE_DESCRIPTIONS.md b/extras/docs/FILE_DESCRIPTIONS.md index a4ee2d8..9d9fcb7 100644 --- a/extras/docs/FILE_DESCRIPTIONS.md +++ b/extras/docs/FILE_DESCRIPTIONS.md @@ -8,15 +8,15 @@ Provides information so that this library can be installed and updated in the Ar The value of *version* must be set to the latest stable tagged release. This should be changed and commited just before tagging the new release. -See the [Arduino IDE 1.5: Library specification](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification) for details. +See the [Arduino IDE 1.5: Library specification](https://arduino.github.io/arduino-cli/library-specification/) for details. ### /library.json -This JSON file is a manifest used by the [PlatformIO IDE](http://platformio.org/) to make this library available in its [Library Manager](http://docs.platformio.org/en/latest/librarymanager/index.html). +This JSON file is a manifest used by the [PlatformIO IDE](https://platformio.org/) to make this library available in its [Library Manager](https://docs.platformio.org/en/latest/librarymanager/index.html). The value of *version* must be set to the latest stable tagged release. This should be changed and commited just before tagging the new release. -See the [PlatformIO library.json](http://docs.platformio.org/en/latest/librarymanager/config.html) documentation for details. +See the [PlatformIO library.json](https://docs.platformio.org/en/latest/librarymanager/config.html) documentation for details. ### /extras/assets/arduboy_logo.png
/extras/assets/arduboy_screen.png diff --git a/src/Arduboy2.h b/src/Arduboy2.h index 6796a90..f6c9c24 100644 --- a/src/Arduboy2.h +++ b/src/Arduboy2.h @@ -702,9 +702,6 @@ class Arduboy2Base : public Arduboy2Core * \details * Draw a bitmap starting at the given coordinates from an array that has * been compressed using an algorthm implemented by Team A.R.G. - * For more information see: - * https://github.com/TEAMarg/drawCompressed - * https://github.com/TEAMarg/Cabi * * Bits set to 1 in the provided bitmap array will have their corresponding * pixel set to the specified color. For bits set to 0 in the array, the @@ -1492,7 +1489,7 @@ class Arduboy2 : public Print, public Arduboy2Base * This character will be ignored. * * See: - * https://www.arduino.cc/en/Serial/Print + * https://www.arduino.cc/reference/en/language/functions/communication/serial/print/ * * Example: * \code{.cpp}