Skip to content

Commit 3a8af35

Browse files
committed
Update toplevel files.
Integrate old INSTALL into README.md, both files had a lot of (potential) overlap. Add template for new entries in NEWS, targetting next release. Bump version number to 6.99-20211218 Tentatively, with the Github migration and all ongoing code restructuring, we aim for a version 7.0 release at some point in the future.
1 parent 6404e78 commit 3a8af35

File tree

4 files changed

+114
-58
lines changed

4 files changed

+114
-58
lines changed

INSTALL

Lines changed: 1 addition & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,4 @@
11
Installation Instructions
22
*************************
33

4-
Use `./configure; make all; sudo make install' for Unix-like systems.
5-
6-
Depending on your requirements, the following prerequisites are
7-
needed:
8-
9-
* libelf including header files (for directly reading ELF files)
10-
* libusb 0.1 or 1.0 (or compatible), including header files
11-
* libftdi or libftdi1 (for direct access to FTDI devices)
12-
* libhidapi or libhid (for access to recent Atmel/Microchip dongles)
13-
14-
If the header and/or library files for one of those are found in
15-
non-default locations, you can add them to configure, e.g.
16-
17-
`./configure CPPFLAGS=-I/opt/local/include LDFLAGS=-L/opt/local/lib'
18-
19-
as an example for MacOS using Macports. MacOS Brew requires
20-
21-
`./configure CPPFLAGS=-I/usr/local/include LDFLAGS=-L/usr/local/Cellar'
22-
23-
instead. (LDFLAGS and CPPFLAGS can also be supplied as environment
24-
variables to configure.)
25-
26-
At the end of the configure script, a configuration summary is issued,
27-
like this:
28-
29-
Configuration summary:
30-
----------------------
31-
DO HAVE libelf
32-
DO HAVE libusb
33-
DO HAVE libusb_1_0
34-
DO HAVE libftdi1
35-
DON'T HAVE libftdi
36-
DON'T HAVE libhid
37-
DO HAVE libhidapi
38-
DO HAVE pthread
39-
DISABLED doc
40-
DISABLED parport
41-
DISABLED linuxgpio
42-
DISABLED linuxspi
43-
44-
Make sure all the features you are interested in have been found.
45-
46-
For BSD-like systems, using GNU make (gmake) is not mandatory but
47-
appears to cause less troubles with the quite complex dependency graph
48-
that might be produced by autoconf/automake.
49-
50-
For Windows, right now, a toolset like MinGW is required to compile
51-
AVRDUDE.
52-
53-
Obviously, a working C compiler is needed. Tested compilers so far
54-
include GCC (in various versions) and Clang. The compiler needs to
55-
support (at least) C99 language level. For MacOS, either Xcode or the
56-
(smaller) Xcode Command Line tools are needed, for Windows, some port
57-
of GCC that supports generating native Windows executables.
4+
See README.md.

NEWS

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,29 @@ $Id$
22

33
Approximate change log for AVRDUDE by version.
44

5-
(For more detailed changes, see the ChangeLog file.)
5+
(For detailed changes, see the version control system logs.)
66

77
----------------------------------------------------------------------
8+
Changes since version 6.4:
9+
10+
* Major changes compared to the previous version:
11+
12+
13+
* New devices supported:
14+
15+
16+
* New programmers supported:
17+
18+
19+
* Bugfixes:
20+
21+
22+
* Patches:
23+
24+
25+
* Internals:
26+
27+
828
Version 6.4:
929

1030
* Major changes compared to the previous version:

README.md

Lines changed: 91 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ programming instruction to the AVR chip regardless of whether AVRDUDE
99
implements that specific feature of a particular chip.
1010

1111
AVRDUDE was originally written in 2003 by Brian S. Dean. Since 2006, AVRDUDE has been maintained by Jörg Wunsch,
12-
with the help of [various contributors](https://github.com/avrdudes/avrdude/graphs/contributors).
12+
with the help of [various contributors](./AUTHORS).
1313

1414
The latest version of AVRDUDE is always available here:\
1515
<https://github.com/avrdudes/avrdude>
1616

1717
## Getting AVRDUDE for Windows
1818

19-
To get AVRDUDE for Windows, install the latest version from the [Releases](./releases) page:
19+
To get AVRDUDE for Windows, install the latest version from the [Releases](http://download.savannah.gnu.org/releases/avrdude/) page.
2020

2121
Alternatively, you may [build AVRDUDE](#building-avrdude-for-windows) yourself from source.
2222

@@ -30,6 +30,12 @@ sudo apt-get install avrdude
3030

3131
Alternatively, you may [build AVRDUDE](#building-avrdude-for-linux) yourself from source.
3232

33+
## Getting AVRDUDE for MacOS
34+
35+
On MacOS, AVRDUDE can be installed through Mac Ports.
36+
37+
Alternatively, you may [build AVRDUDE](#building-avrdude-for-macos) yourself from source.
38+
3339
## Using AVRDUDE
3440

3541
AVRDUDE is a command-line application. Run the command `avrdude` without any arguments for a list of options.
@@ -50,6 +56,59 @@ avrdude -c arduino -P COM1 -b 115200 -p atmega328p -D -U flash:w:objs/blink.hex:
5056
There are many different programmers and options that may be required for the programming to succeed.
5157
For more information, refer to the [AVRDUDE documentation](#todo).
5258

59+
## General build instructions
60+
61+
### Prerequisites
62+
63+
Depending on your requirements, the following prerequisites are
64+
needed:
65+
66+
* libelf including header files (for directly reading ELF files)
67+
* libusb 0.1 or 1.0 (or compatible), including header files
68+
* libftdi or libftdi1 (for direct access to FTDI devices)
69+
* libhidapi or libhid (for access to recent Atmel/Microchip dongles)
70+
71+
### Building
72+
73+
All source code is located in the `src/` subdirectory. Thus all
74+
instructions are relative to that directory.
75+
76+
Source-code releases contain an up-to-date configure script that
77+
can be run to generate the required Makefiles:
78+
79+
```console
80+
cd src && ./configure && make && sudo make install
81+
```
82+
At the end of the configure script, a configuration summary is issued,
83+
like this:
84+
85+
```console
86+
Configuration summary:
87+
----------------------
88+
DO HAVE libelf
89+
DO HAVE libusb
90+
DO HAVE libusb_1_0
91+
DO HAVE libftdi1
92+
DON'T HAVE libftdi
93+
DON'T HAVE libhid
94+
DO HAVE libhidapi
95+
DO HAVE pthread
96+
DISABLED doc
97+
DISABLED parport
98+
DISABLED linuxgpio
99+
DISABLED linuxspi
100+
```
101+
102+
Make sure all the features you are interested in have been found.
103+
104+
Building the development source tree might possibly require to
105+
re-generate the configure script using the autoconf/automake
106+
tools. This can be done using the `bootstrap` script:
107+
108+
```console
109+
cd src && ./bootstrap
110+
```
111+
53112
## Building AVRDUDE for Windows
54113

55114
### Windows Prerequisites
@@ -95,6 +154,36 @@ cd doc
95154
make all
96155
```
97156

157+
## Building AVRDUDE for MacOS
158+
159+
### Prerequisites
160+
161+
The following things are needed to build AVRDUDE on MacOS:
162+
163+
* a C compiler; either full XCode, or the XCode Command Line tools
164+
* autoconf, automake, libtool, hidapi, libftdi1, libusb, libelf;
165+
they can be installed e.g. from Mac Ports using
166+
```console
167+
port install autoconf automake \
168+
libtool hidapi libftdi1 libusb libelf
169+
```
170+
171+
### Compilation
172+
173+
Depending on the location of the prerequisites, the `CPPFLAGS` and
174+
`LDFLAGS` variables need to be set accordingly. Mac Ports installs
175+
everything under `/opt/local`, so use
176+
177+
```console
178+
./configure CPPFLAGS=-I/opt/local/include LDFLAGS=-L/opt/local/lib
179+
```
180+
181+
MacOS Brew requires
182+
183+
```console
184+
./configure CPPFLAGS=-I/usr/local/include LDFLAGS=-L/usr/local/Cellar
185+
```
186+
98187
## License
99188

100189
AVRDUDE is licensed under the [GNU GPLv2](./COPYING).

src/configure.ac

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
# Process this file with autoconf to produce a configure script.
2424

2525
AC_PREREQ(2.60)
26-
AC_INIT(avrdude, 6.4, avrdude-dev@nongnu.org)
26+
AC_INIT(avrdude, 6.99-20211218, avrdude-dev@nongnu.org)
2727

2828
AC_CANONICAL_BUILD
2929
AC_CANONICAL_HOST

0 commit comments

Comments
 (0)