giomba
/
nes-proj
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

small clarifications to the README.

This commit is contained in:
Mariano Alvira 2010-02-28 09:17:58 -05:00
parent 78be082b3c
commit f113136745
1 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README
View File

@ -1,12 +1,12 @@
libmc1322x is a library and build system for using the mc13224v from libmc1322x is a library, build system, test code, and utilities for
Freescale. using the mc13224v from Freescale.
Getting Started Getting Started
--------------- ---------------
$ cd tests $ cd tests
$ make $ make
this will build all the test files in libmc1322x/tests _for each_ board this will build all the test files in libmc1322x/tests for each board
defined in libmc1322x/board. You will have programs like: defined in libmc1322x/board. You will have programs like:
rftest-tx_redbee-dev.bin rftest-tx_redbee-dev.bin
@ -19,7 +19,7 @@ if you only wanted to build binaries for one board you can do:
$ make BOARD=redbee-dev $ make BOARD=redbee-dev
You can use mc1322x-load.pl in tools to run your code: You can use mc1322x-load.pl in libmc1322x/tools to run your code:
$ ../tools/mc1322x-load.pl -f rftest-tx_redbee-dev.bin $ ../tools/mc1322x-load.pl -f rftest-tx_redbee-dev.bin
@ -27,14 +27,14 @@ $ ../tools/mc1322x-load.pl -f rftest-tx_redbee-dev.bin
Incorporating libmc1322x into your own code Incorporating libmc1322x into your own code
------------------------------------------- -------------------------------------------
The best way is to incorporate libmc1322x as a git submodule in your The best way to incorporate libmc1322x into your code is as a git
own code. submodule:
$ mkdir newproject $ mkdir newproject
$ cd newproject $ cd newproject
$ git init $ git init
Initialized empty Git repository in /home/malvira/newproject/.git/ Initialized empty Git repository in /home/malvira/newproject/.git/
$ git submodule add git://git.devl.org/git/malvira/libmc1322x.git $ git submodule add git://git.devl.org/git/malvira/libmc1322x.git
@ -43,30 +43,32 @@ Makefile:
$ cp libmc1322x/tests/Makefile . $ cp libmc1322x/tests/Makefile .
You need to edit the Makefile to point MC1322X to libmc1322x: You need to edit the Makefile to point MC1322X to your libmc1322x
submodule:
Change line 1 Change line 1
MC1322X := .. MC1322X := ..
to to
MC1322X := libmc1322x MC1322X := libmc1322x
and edit COBJS and TARGETS accordings. COBJS are all of your common and edit COBJS and TARGETS accordings. COBJS are all of your common
code for any of your programs. TARGETS are the names of you programs. code for any of your programs. TARGETS are the names of your programs.
For instance, you can have a common routine that prints a welcome For instance, you can have a common routine that prints a welcome
message that is used by two programs a and b. You would add common.o message that is used by two programs a and b. You would add common.o
to COBJS and your target line would read: to COBJS:
TARGETS := a b COBJS:= common.o
and your target line would read:
TARGETS := a b
COBJS are made for each board --- so it is ok to have board specific COBJS are made for each board --- so it is ok to have board specific
code in there. As an example, tests uses this to print which board you code in there. As an example, tests uses this in tests.c to print the
are running. name of the board in the welcome message. You could also use this to
change your GPIO mappings between boards.