xref: /btstack/chipset/sx128x/SMTC_Drivers/sx1280-driver-c/readme.md (revision cb5466b0821ff1cc151be285948f59ccf7756451)
1*cb5466b0SMatthias Ringwald      ______                              _
2*cb5466b0SMatthias Ringwald     / _____)             _              | |
3*cb5466b0SMatthias Ringwald    ( (____  _____ ____ _| |_ _____  ____| |__
4*cb5466b0SMatthias Ringwald     \____ \| ___ |    (_   _) ___ |/ ___)  _ \
5*cb5466b0SMatthias Ringwald     _____) ) ____| | | || |_| ____( (___| | | |
6*cb5466b0SMatthias Ringwald    (______/|_____)_|_|_| \__)_____)\____)_| |_|
7*cb5466b0SMatthias Ringwald        (C)2016 Semtech
8*cb5466b0SMatthias Ringwald
9*cb5466b0SMatthias RingwaldSX1280 drivers C
10*cb5466b0SMatthias Ringwald=======================
11*cb5466b0SMatthias Ringwald
12*cb5466b0SMatthias Ringwald1. Introduction
13*cb5466b0SMatthias Ringwald----------------
14*cb5466b0SMatthias RingwaldThis project feature a C porting of the SX1280 driver originally developped in CPP on top of mbed library.
15*cb5466b0SMatthias Ringwald
16*cb5466b0SMatthias Ringwald2. Repository work flow
17*cb5466b0SMatthias Ringwald-----------------------
18*cb5466b0SMatthias RingwaldThe work flow of the repository applies to the gitflow work flow. For detailed information, please take a look at: https://github.com/nvie/gitflow or http://nvie.com/posts/a-successful-git-branching-model/.
19*cb5466b0SMatthias RingwaldThe repository contains different branches:
20*cb5466b0SMatthias Ringwald* master
21*cb5466b0SMatthias Ringwald  The master branch contains the only stable versions which passes the LoRaWAN compliance tests. Therefore if you checkout the repo without switching the branch, you're automatically using the most recent stable version of the stack.
22*cb5466b0SMatthias Ringwald* develop
23*cb5466b0SMatthias Ringwald  The develop branch provides updates to master branch. It shows the progress of development for the repository. When the develop branch is ready for a release, a release branch will be created at this point. The repository must contain only one develop branch! In general, the develop branch is not a stable version and might not pass the LoRaWAN compliance tests.
24*cb5466b0SMatthias Ringwald* release
25*cb5466b0SMatthias Ringwald  As soon as we branch from develop to release branch, no further features will be integrated for the upcoming release. This branch is basically for polishing and fixing issues that relevant for the upcoming release only. As soon as this version passes the compliance test, it'll be merged into master branch.
26*cb5466b0SMatthias Ringwald* feature
27*cb5466b0SMatthias Ringwald  A feature branch reflects the development process on a specific feature. The repository might contain several feature branches. If a feature is ready, the related feature branch will be merged into the develop branch.
28*cb5466b0SMatthias Ringwald
29*cb5466b0SMatthias RingwaldA script has been designed to help include this driver with the correct version. Check *repo-init.sh* in firmware projects to see which version of SX1280 driver is in use.
30*cb5466b0SMatthias Ringwald
31*cb5466b0SMatthias Ringwald
32*cb5466b0SMatthias Ringwald
33*cb5466b0SMatthias Ringwald3. Dependencies
34*cb5466b0SMatthias Ringwald----------------
35*cb5466b0SMatthias Ringwald
36*cb5466b0SMatthias Ringwald4. Usage
37*cb5466b0SMatthias Ringwald---------
38*cb5466b0SMatthias Ringwald
39*cb5466b0SMatthias Ringwald5. Changelog
40*cb5466b0SMatthias Ringwald-------------
41*cb5466b0SMatthias RingwaldSee changelog.md file
42