Skip to content

Commit 1cbd451

Browse files
committedMar 23, 2023
Standardize formatting of Licence.md.
1 parent aada8ea commit 1cbd451

File tree

4 files changed

+53
-31
lines changed

4 files changed

+53
-31
lines changed
 

‎LICENSE.md

+23-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# GNU LESSER GENERAL PUBLIC LICENSE
1+
# DxCore, megaTinyCore, and ATTinyCore are released under the LGPL version 2.1
2+
All files included with these package are covered by this unless
3+
otherwise noted. *Some included files and libraries are covered by other
4+
licenses.* Any file licensed under terms other than the LGPL 2.1 will have
5+
prominent notice of such at the top of the file, including the full text
6+
of the boilerplate, as well as applicable license files in the directory.
7+
8+
Files licensed under the LGPL 2.1 may have that text abbreviated for
9+
readability. The LGPL 2.1 license text is reproduced below verbatim
10+
with no modifications beyond markdown formatting.
11+
12+
## GNU LESSER GENERAL PUBLIC LICENSE
213

314
Version 2.1, February 1999
415

@@ -166,13 +177,13 @@ portion of it, thus forming a work based on the Library, and copy and
166177
distribute such modifications or work under the terms of Section 1
167178
above, provided that you also meet all of these conditions:
168179

169-
- **a)** The modified work must itself be a software library.
170-
- **b)** You must cause the files modified to carry prominent
180+
- **a)** The modified work must itself be a software library.
181+
- **b)** You must cause the files modified to carry prominent
171182
notices stating that you changed the files and the date of
172183
any change.
173-
- **c)** You must cause the whole of the work to be licensed at no
184+
- **c)** You must cause the whole of the work to be licensed at no
174185
charge to all third parties under the terms of this License.
175-
- **d)** If a facility in the modified Library refers to a function
186+
- **d)** If a facility in the modified Library refers to a function
176187
or a table of data to be supplied by an application program that
177188
uses the facility, other than as an argument passed when the
178189
facility is invoked, then you must make a good faith effort to
@@ -283,7 +294,7 @@ copyright notice for the Library among them, as well as a reference
283294
directing the user to the copy of this License. Also, you must do one
284295
of these things:
285296

286-
- **a)** Accompany the work with the complete corresponding
297+
- **a)** Accompany the work with the complete corresponding
287298
machine-readable source code for the Library including whatever
288299
changes were used in the work (which must be distributed under
289300
Sections 1 and 2 above); and, if the work is an executable linked
@@ -294,22 +305,22 @@ of these things:
294305
the user who changes the contents of definitions files in the
295306
Library will not necessarily be able to recompile the application
296307
to use the modified definitions.)
297-
- **b)** Use a suitable shared library mechanism for linking with
308+
- **b)** Use a suitable shared library mechanism for linking with
298309
the Library. A suitable mechanism is one that (1) uses at run time
299310
a copy of the library already present on the user's computer
300311
system, rather than copying library functions into the executable,
301312
and (2) will operate properly with a modified version of the
302313
library, if the user installs one, as long as the modified version
303314
is interface-compatible with the version that the work was
304315
made with.
305-
- **c)** Accompany the work with a written offer, valid for at least
316+
- **c)** Accompany the work with a written offer, valid for at least
306317
three years, to give the same user the materials specified in
307318
Subsection 6a, above, for a charge no more than the cost of
308319
performing this distribution.
309-
- **d)** If distribution of the work is made by offering access to
320+
- **d)** If distribution of the work is made by offering access to
310321
copy from a designated place, offer equivalent access to copy the
311322
above specified materials from the same place.
312-
- **e)** Verify that the user has already received a copy of these
323+
- **e)** Verify that the user has already received a copy of these
313324
materials or that you have already sent this user a copy.
314325

315326
For an executable, the required form of the "work that uses the
@@ -334,11 +345,11 @@ library, provided that the separate distribution of the work based on
334345
the Library and of the other library facilities is otherwise
335346
permitted, and provided that you do these two things:
336347

337-
- **a)** Accompany the combined library with a copy of the same work
348+
- **a)** Accompany the combined library with a copy of the same work
338349
based on the Library, uncombined with any other
339350
library facilities. This must be distributed under the terms of
340351
the Sections above.
341-
- **b)** Give prominent notice with the combined library of the fact
352+
- **b)** Give prominent notice with the combined library of the fact
342353
that part of it is a work based on the Library, and explaining
343354
where to find the accompanying uncombined form of the same work.
344355

‎Programming.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Programming the ATtiny parts
1+
# Programming the ATtiny parts
22

33
All parts supported by ATTinyCore can be programmed using ISP (also called ICSP or SPI programming), using the SCK, MISO, MOSI and Reset pins. Most breakout boards (including all the ones I sell) provide a 6-pin (2x3) ISP programming header that matches the 6-pin connector used on common programmers. You will need an ISP programmer - the USBAsp and USBTinyISP programmers are readily available from ebay, amazon, aliexpress and many other vendors, typically for prices of around $3. If you get a USBAsp, be sure to get one with the 10-pin to 6-pin adapter. You can also use another Arduino (I know the AVR-based ones work, eg, nano, uno, pro mini - I can't make any promises about the fancier, non-AVR boards) using the Arduino as ISP sketch; upload this sketch to the board, and then place a approx. 10uF (within a factor of 10) capacitor between reset and ground on that Arduino (this disables autoreset - it must be removed before you try to upload a different sketch).
44

@@ -8,7 +8,7 @@ In the following sections, the "programmer" is the ISP programmer or Arduino run
88

99
We recommend that everyone enable Verbose Uploads - in Preferences, under "Show Verbose Output During", check "Upload" (we recommend unchecking "Compiling" unless chasing down a mysterious compile failure, as it produces a lot of output that usually isn't relevant).
1010

11-
### Programming via ISP (for burning bootloader, and uploading to non-optiboot boards)
11+
## Programming via ISP (for burning bootloader, and uploading to non-optiboot boards)
1212
Ensure that you have connected all necessary external components (see [Wiring Guide](Wiring.md). If you have an ISP programmer with the 6-pin header, and a 6-pin header on the board, connect it to the board. If you are using Arduino as ISP, the connections are:
1313

1414
* Vcc of programmer to Vcc of target
@@ -43,7 +43,7 @@ If burning the bootloader, do Tools -> Burn Bootloader. You should see output on
4343

4444
If uploading a sketch, click upload. You should see output on the console reporting that the sketch was successfully uploaded.
4545

46-
#### FTDI in bitbang mode?
46+
## FTDI in bitbang mode?
4747
Go search aliexpress, or ebay, or whatever the equivalent is in your country. You will find a blue "FTDI" serial adapter. Look through the designs on offer until you see one with a mini USB connector a switch to select voltage, an unmarked 2x3 set of pins in the middle, and the normal FTDI pinout. The build quality is abysmal, the last batch I got, it felt like the solder had been severely oxidized, the chip was off center on most of them, and obviously the FTDI chip is one of the counterfeits (which seem to work just as well as any that I've tried.... they run under $2 US on aliexpress. That mysterious 2x3 header? Yeah, that's for ISP programming using synchronous bitbang mode. This option enables it, a feature that in and of it self makes this the best of the FT232 clone adapter boards, and quite an appealing package. It can have the added diode and/or resistors to act as a UPDI programmer on modern AVRs connected permanently and still do ISP like this!
4848
For other FT232RL adapters that break out the modem control lines, it's:
4949

@@ -58,7 +58,7 @@ Note that this can only be done with FT232RL's.
5858

5959
This is not the same as the protocols that involve any-old-serial-adapter's modem control lines, generally using a pulse on TX in place of SCK, and reading one bit at a time from a modem control input amd semdomg the same. Those are agonizingly slow, only a desperation tactic to get optiboot onto something when you've just got nothing. They are not supported by this core.
6060

61-
### Programming via Serial (Optiboot)
61+
## Programming via Serial (Optiboot)
6262

6363
Ensure that you have connected all necessary external components (see [Wiring Guide](Wiring.md)), including the autoreset circuit. Unless you are using a breakout/development board where the bootloader was preinstalled, you must use an ISP programmer to "burn bootloader" as described above before you can reprogram it via serial. If you have a board with the 1x6 pin "FTDI" serial header, and a programmer with the same pinout, they can be connected directly, otherwise, make the following connections:
6464

@@ -76,7 +76,7 @@ On the t841, t441, t1634, and t828, pages are erased on blocks of four. The boot
7676
**Warning about Optiboot on non ATtiny828 devices**
7777
On parts that do not have hardware bootloader support (only the 828 has that), Optiboot uses "Virtual Boot" to rewrite the vector table as it writes the flash, using the EE_RDY vector to store the address that the program starts at. The problem arises if there is a very poorly timed interruption - for example, a mis-timed reset pulse after programming has started, or a brownout that causes a reset. If this happens at just the wrong moment, the first page of flash can be erased, but not rewritten. While that sounds unlikely, it has been encountered twice in internal testing. When this happens, the part will require ISP programming to unbrick. See #398. Until this issue is resolved, **Optiboot is not for production.** That is to say, if devices are to be deployed in a situation where they will be reprogrammed via serial "in the field", but where ISP programming is impractical, this is not a safe solution.
7878

79-
### Tips and Tricks
79+
## Tips and Tricks
8080
* If you have a breakout board with holes for the 6-pin header, but don't want to solder pin header onto it, no problem. Just put a plug a piece of pin header into the connector on the programmer, insert it in the holes, and hold it at an angle, applying gentle pressure to make sure the pins make contact while you run the programming command. I use this technique routinely - it's how I used to bootload the boards I sell; you can also buy a "pogo-pin adapter" which has 6 spring loaded pins, which is a bit easier to handle (this is what I use now).
8181

8282
* Be sure you are plugging in the connector on the top of the board - if it is plugged in backwards, but on the correct side, it will not damage the board; if you don't know which way to orient the connector, you can try them both, and the one that works is correct. However, if you were to put the header in on the wrong side of the board, it would likely damage the board.

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ ATTinyCore supports classic ATtiny parts. It does not support any other AVR devi
5454
* [tinyAVR 0/1/2-series](https://github.com/SpenceKonde/megaTinyCore/) Modern tinyAVR (with 0, 1, or 2 as next-to-last digit) are supported by my megaTinyCore instead. They are totally different in every way except the "t-word" in the name, and many of them have a peripheral selection to make most classic AVRs turn gteen with envy (like a 3227 or 3226's peripera;s beat the stuffing out of many classic AVR parts, including the 328pb
5555
* [ATtiny13/13A](https://github.com/MCUdude/MicroCore/) are supported by MicroCore by @MCUdude - 2k of flash is the lower cutoff for ATTinyCore.
5656
* The ATtiny28L is not supported by any Arduino core. It is older than the hills, weirder than quantum physics... AND IT DOESN'T HAVE RAM! IT ONLY HAS REGISTERS! Put it back into the museum case where you got it before the security guards notice it missing from the "prehistoric man and computing" exhibit.
57-
* ATtiny 4/5/10/11 and the 10x tinyAVRs, or any other "AVRrc" (reduced core) parts/ these combine minuscule memory sizes with a gimped CPU. [Try this core](https://github.com/technoblogy/attiny10core) if you are a masochist and extremely space constrained. The core has to cut significant parts of the API in order to fit. These parts are kinda lousy - there is a point when trying to use smaller and smaller microcontrollers stops being fun and starts being just annoying. These parts, for example. With the exception of the ATtiny28L, and some discontinued parts not included on this list, any other AVR more capable that these things, and it's not like the discount for losing all that functionality is worth it.
57+
* ATtiny 4/5/10/11 and the 10x tinyAVRs, or any other "AVRrc" (reduced core) parts/ these combine minuscule memory sizes with a gimped CPU. [Try this core](https://github.com/technoblogy/attiny10core) if you are a masochist and extremely space constrained. The core has to cut significant parts of the API in order to fit. These parts are kinda lousy - there is a point when trying to use smaller and smaller microcontrollers stops being fun and starts being just annoying. These parts, for example. With the exception of the ATtiny28L, and some discontinued parts not included on this list, any other AVR more capable that these things, and it's not like the discount for losing all that functionality is worth it.
5858
* Anything with "ATmega" in the name - you want [one of MCUDude's cores](https://github.com/MCUdude/) - he has one for almost every ATmega part. '
5959
* The ATmegaXXcN and XXmN where X is the flash size and N is a small number. There is no core supporting these rarely seen or discussed classic AVRs. The c's are a follow-on to the ATCAN series (the older CAN parts are supported by some of MCUDude's cores) and the m series the follow-on to the PWM-centric parts of the same vintage (The more recent modern AVRs - namely the tinyAVR 1-series and Dx-series - have a Type D timer, which was clearly inspired by the PWM controller on those parts, making it interesting to those who study feature evolution semiconductors).
6060
* AVR Dx-series (AVR128DA64, etc) - [the crown jewel of the AVR product line](https://github.com/SpenceKonde/), supported by my DxCore.
61-
* AVR Ex-series (AVR64EA48, AVR32EB32, not yet for sale) will also be supported by DxCore ones the datasheets is available to clear up a few remaining questions about the EA and a ton of questions about the EB.
61+
* AVR Ex-series (AVR64EA48, AVR32EB32, not yet for sale) will also be supported by DxCore ones the datasheets is available to clear up a few remaining questions about the EA and a ton of questions about the EB.
6262

6363
## Quick Gotchas/FAQ list
6464
### Having trouble? read these first!

‎avr/LICENSE.md

+23-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# GNU LESSER GENERAL PUBLIC LICENSE
1+
# DxCore, megaTinyCore, and ATTinyCore are released under the LGPL version 2.1
2+
All files included with these package are covered by this unless
3+
otherwise noted. *Some included files and libraries are covered by other
4+
licenses.* Any file licensed under terms other than the LGPL 2.1 will have
5+
prominent notice of such at the top of the file, including the full text
6+
of the boilerplate, as well as applicable license files in the directory.
7+
8+
Files licensed under the LGPL 2.1 may have that text abbreviated for
9+
readability. The LGPL 2.1 license text is reproduced below verbatim
10+
with no modifications beyond markdown formatting.
11+
12+
## GNU LESSER GENERAL PUBLIC LICENSE
213

314
Version 2.1, February 1999
415

@@ -166,13 +177,13 @@ portion of it, thus forming a work based on the Library, and copy and
166177
distribute such modifications or work under the terms of Section 1
167178
above, provided that you also meet all of these conditions:
168179

169-
- **a)** The modified work must itself be a software library.
170-
- **b)** You must cause the files modified to carry prominent
180+
- **a)** The modified work must itself be a software library.
181+
- **b)** You must cause the files modified to carry prominent
171182
notices stating that you changed the files and the date of
172183
any change.
173-
- **c)** You must cause the whole of the work to be licensed at no
184+
- **c)** You must cause the whole of the work to be licensed at no
174185
charge to all third parties under the terms of this License.
175-
- **d)** If a facility in the modified Library refers to a function
186+
- **d)** If a facility in the modified Library refers to a function
176187
or a table of data to be supplied by an application program that
177188
uses the facility, other than as an argument passed when the
178189
facility is invoked, then you must make a good faith effort to
@@ -283,7 +294,7 @@ copyright notice for the Library among them, as well as a reference
283294
directing the user to the copy of this License. Also, you must do one
284295
of these things:
285296

286-
- **a)** Accompany the work with the complete corresponding
297+
- **a)** Accompany the work with the complete corresponding
287298
machine-readable source code for the Library including whatever
288299
changes were used in the work (which must be distributed under
289300
Sections 1 and 2 above); and, if the work is an executable linked
@@ -294,22 +305,22 @@ of these things:
294305
the user who changes the contents of definitions files in the
295306
Library will not necessarily be able to recompile the application
296307
to use the modified definitions.)
297-
- **b)** Use a suitable shared library mechanism for linking with
308+
- **b)** Use a suitable shared library mechanism for linking with
298309
the Library. A suitable mechanism is one that (1) uses at run time
299310
a copy of the library already present on the user's computer
300311
system, rather than copying library functions into the executable,
301312
and (2) will operate properly with a modified version of the
302313
library, if the user installs one, as long as the modified version
303314
is interface-compatible with the version that the work was
304315
made with.
305-
- **c)** Accompany the work with a written offer, valid for at least
316+
- **c)** Accompany the work with a written offer, valid for at least
306317
three years, to give the same user the materials specified in
307318
Subsection 6a, above, for a charge no more than the cost of
308319
performing this distribution.
309-
- **d)** If distribution of the work is made by offering access to
320+
- **d)** If distribution of the work is made by offering access to
310321
copy from a designated place, offer equivalent access to copy the
311322
above specified materials from the same place.
312-
- **e)** Verify that the user has already received a copy of these
323+
- **e)** Verify that the user has already received a copy of these
313324
materials or that you have already sent this user a copy.
314325

315326
For an executable, the required form of the "work that uses the
@@ -334,11 +345,11 @@ library, provided that the separate distribution of the work based on
334345
the Library and of the other library facilities is otherwise
335346
permitted, and provided that you do these two things:
336347

337-
- **a)** Accompany the combined library with a copy of the same work
348+
- **a)** Accompany the combined library with a copy of the same work
338349
based on the Library, uncombined with any other
339350
library facilities. This must be distributed under the terms of
340351
the Sections above.
341-
- **b)** Give prominent notice with the combined library of the fact
352+
- **b)** Give prominent notice with the combined library of the fact
342353
that part of it is a work based on the Library, and explaining
343354
where to find the accompanying uncombined form of the same work.
344355

0 commit comments

Comments
 (0)
Please sign in to comment.