Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor build configuration into site_scons module #21

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
.sconsign.dblite
*.elf
*.hex
*.pyc
build/
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,38 @@ build & upload Arduino sketch on the command line with scons!

## Basic Usage:

- make a folder which have same name of the sketch (ex. Blink/ for Blink.pde)
- put the sketch and the SConstruct under the folder.
- to make the HEX do following in the folder:
1. Make a directory which have same name of the sketch (ex. Blink/ for Blink.pde)
* Note that, as a convenience, if the sketch does _not_ have the same name
as the parent directory, compilation will still be performed if it is the
only file in the directory with the extension `.pde` or `.ino`
2. Put the sketch, `SConstruct`, and the directory `site_scons` under the
sketch directory.
3. To compile the `.hex`-file, do following in the directory:

$ scons
$ scons

- to upload the binary, do following in the folder:
4. To upload the binary, do following in the directory:

$ scons upload
$ scons upload

- refer [Expert Usage](https://github.com/suapapa/arscons/wiki/Expert-Usage) for change the confs.
- refer [Arscons Users](https://github.com/suapapa/arscons/wiki/Arscons-Users) for arscons in practice (and hacks!)
- Refer [Expert Usage](https://github.com/suapapa/arscons/wiki/Expert-Usage)
for change the confs.
- Refer [Arscons Users](https://github.com/suapapa/arscons/wiki/Arscons-Users)
for arscons in practice (and hacks!).

## `site_scons.arduino_build` module:

In addition to the basic usage described above, the `site_scons.arduino_build`
module may be included in other projects using SCons to build any Arduino
components. The `site_scons` directory provides a way to integrate custom
builders and tools for SCons. See [here][1] for more information about
`site_scons` support in SCons.

## Thanks to:

- Ovidiu Predescu <[email protected]> and Lee Pike <[email protected]> for Mac port and bugfix.
- Steven Ashley <[email protected]> for Windows port.
- Kyle Gordon for many patches which including Arduino-1 support


[1]: http://www.scons.org/doc/1.0.1/HTML/scons-user/x3627.html
Loading