From ca24ecf9c25f54c7c725ebd0d1f2894feffd4a8e Mon Sep 17 00:00:00 2001 From: Elijah Insua Date: Mon, 20 May 2013 16:46:28 -0700 Subject: [PATCH] add basic readme --- package.json | 6 ++++-- readme.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 5826a39..5f747a4 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,13 @@ { "name": "avr", - "version": "0.0.0", + "version": "0.0.1", "description": "avr project tools", - "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, + "bin" : { + "avr" : "/index.js" + }, "repository": { "type": "git", "url": "git://github.com/tmpvar/avr.git" diff --git a/readme.md b/readme.md index e69de29..7c5c57f 100644 --- a/readme.md +++ b/readme.md @@ -0,0 +1,44 @@ +# avr + +avr project tools + +This module allows you to mix and match components for avr embedded development. You can either pull from github or a local directory and there is no need to modify a makefile. + +## install + +Make sure you have `avrdude`, `avr-gcc` and friends installed. On osx you can do that by installing [CrossPack](http://www.obdev.at/avrmacpack/) or using brew/macports + +`npm install -g avr` + +## use + +`avr ` + +### commands + +#### init [path/to/project] + +initialize the current directory as a new project or create the specified directory and initialize there + +#### build + +calls out to `avr-gcc` and compiles/links the sources specified in the `avr.json` file + +`sources` found in `deps/*/avr.json` are also compiled and the resulting artifacts are put in `./build/` + +#### flash + +performs a `build` and invokes `avrdude` based on the settings in `avr.conf` + +#### install [../path/to/project | githubuser/project] + +puts a local copy of `project` into your `./deps/` directory + +#### delete [project] + +removes the local copy of project from `./deps/` + + +## license + +MIT \ No newline at end of file