Skip to content

Commit

Permalink
Makefile info.
Browse files Browse the repository at this point in the history
  • Loading branch information
nixpulvis committed Oct 6, 2015
1 parent 2dd6b87 commit 633ed7b
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,29 @@ These instructions are for installing the needed dependencies on OS X, Linux doc

It's important to me to make building things easy. I've made a Makefile which aims to make compiling and flashing AVRs as easy as possible. It tries to help you out too, for example it will find a `/dev/tty.usb*` device automatically.

TODO: Finish this.
```sh
make # Compiles the library.
make install # Compiles the library, and installs it on the system.
make test # Compiles the library, installs it, and compiles the tests.
make clean # Removes compiled artifacts.
make uninstall # Removes the library from the system.

make size # Displays size information.
make <program>.flash # Compiles and flashes the <program> to a connected AVR.
make serial # Opens a `screen` session to a connected AVR.
```

Below is an example of how to get started.

```sh
# Install the library.
make install
# Flash the uart test program. Remember that the baud rate is different for
# various AVRs.
env AVRDUDE_BAUD=57600 make test/uart_test.flash
# Open a serial connection to the AVR.
make serial
```

## Libraries

Expand Down

0 comments on commit 633ed7b

Please sign in to comment.