Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

features/nanostack/CONTRIBUTING.md@0:5c4d7b2438d3, 2016-11-11 (annotated)

Committer:
switches
Date:
Fri Nov 11 20:59:50 2016 +0000
Revision:
0:5c4d7b2438d3
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
switches 0:5c4d7b2438d3 1 # How to contribute
switches 0:5c4d7b2438d3 2
switches 0:5c4d7b2438d3 3 This directory structure contains some repositories that are copied from external sources.
switches 0:5c4d7b2438d3 4
switches 0:5c4d7b2438d3 5 Please follow these instructions to send contributions to master repositories.
switches 0:5c4d7b2438d3 6
switches 0:5c4d7b2438d3 7 ## Directory structure
switches 0:5c4d7b2438d3 8
switches 0:5c4d7b2438d3 9 This directory consists of following modules
switches 0:5c4d7b2438d3 10
switches 0:5c4d7b2438d3 11 * [coap-service](#coap-service)
switches 0:5c4d7b2438d3 12 * [mbed-mesh-api](#mbed-mesh-api)
switches 0:5c4d7b2438d3 13 * [nanostack-interface](#nanostack-interface)
switches 0:5c4d7b2438d3 14 * [sal-stack-nanostack](#sal-stack-nanostack)
switches 0:5c4d7b2438d3 15
switches 0:5c4d7b2438d3 16 ## coap-service
switches 0:5c4d7b2438d3 17
switches 0:5c4d7b2438d3 18 Master repository is located in the https://github.com/ARMmbed/coap-service
switches 0:5c4d7b2438d3 19
switches 0:5c4d7b2438d3 20 Please send contributions against that repository.
switches 0:5c4d7b2438d3 21
switches 0:5c4d7b2438d3 22 To test changes, remove the `coap-service` repository and replace with Git clone
switches 0:5c4d7b2438d3 23 of the master repository.
switches 0:5c4d7b2438d3 24
switches 0:5c4d7b2438d3 25 ```
switches 0:5c4d7b2438d3 26 rm -rf coap-service
switches 0:5c4d7b2438d3 27 git clone git@github.com:ARMmbed/coap-service.git
switches 0:5c4d7b2438d3 28 ```
switches 0:5c4d7b2438d3 29
switches 0:5c4d7b2438d3 30 ## mbed-mesh-api
switches 0:5c4d7b2438d3 31
switches 0:5c4d7b2438d3 32 This is the master source of mbed-mesh-api.
switches 0:5c4d7b2438d3 33 Send contributions directly to this repository.
switches 0:5c4d7b2438d3 34
switches 0:5c4d7b2438d3 35 ## nanostack-interface
switches 0:5c4d7b2438d3 36
switches 0:5c4d7b2438d3 37 This is the master source of nanostack-interface.
switches 0:5c4d7b2438d3 38 Send contributions directly to this repository.
switches 0:5c4d7b2438d3 39
switches 0:5c4d7b2438d3 40 ## sal-stack-nanostack
switches 0:5c4d7b2438d3 41
switches 0:5c4d7b2438d3 42 This directory holds binary libraries generated from the Nanostack networking library.
switches 0:5c4d7b2438d3 43
switches 0:5c4d7b2438d3 44 **Only mbed Partners have access to the source code.**
switches 0:5c4d7b2438d3 45
switches 0:5c4d7b2438d3 46 If you have access, the source directory is available in https://github.com/ARMmbed/sal-stack-nanostack-private
switches 0:5c4d7b2438d3 47
switches 0:5c4d7b2438d3 48 You can replace the binary libraries with the source tree as follows:
switches 0:5c4d7b2438d3 49
switches 0:5c4d7b2438d3 50 * Remove the sal-stack-nanostack directory: `rm -rf sal-stack-nanostack`
switches 0:5c4d7b2438d3 51 * Remove the binaries located one directory up: `rm -rf ../nanostack-binaries`
switches 0:5c4d7b2438d3 52 * Clone the original source repository to root folder of your application: `git@github.com:ARMmbed/sal-stack-nanostack-private.git`
switches 0:5c4d7b2438d3 53
switches 0:5c4d7b2438d3 54 Now you can modify, build and test your changes with the mbed OS build.
switches 0:5c4d7b2438d3 55
switches 0:5c4d7b2438d3 56 **NOTE:** You do not need to clone the Nanostack to exactly same location in the build tree. This may even cause build problems.
switches 0:5c4d7b2438d3 57
switches 0:5c4d7b2438d3 58 ### Instructions for generating the binary modules
switches 0:5c4d7b2438d3 59
switches 0:5c4d7b2438d3 60 Check `Releasing.md` from the Nanostack source repository.