Skip to content

Commit

Permalink
Update BUILD instructions to use rake tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
4-20ma committed Dec 29, 2012
1 parent 1649b00 commit 438e563
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions BUILD.markdown
Original file line number Diff line number Diff line change
@@ -1,27 +1,25 @@
## Update release version/date
- `VERSION` file (use [semantic versioning](http://semver.org))
- `i2c_adc_ads7828.h` file (`\date` field)
- source documentation (Doxygen command-line):
```
$ cd doc/ && doxygen Doxyfile && cd ..
```
- `HISTORY.markdown` file release history
- update version, as appropriate:
```bash
$ rake version:bump # or
$ rake version:bump:minor # or
$ rake version:bump:major
```

## Commit source code changes
- update `HISTORY.markdown` file:
```bash
$ git add .
$ git commit -v -m "Update ..."
$ git push
$ rake prepare
```

## Tag source code
- update release date, add & commit files, tag, push to origin/master:
```bash
$ git tag vX.Y.Z
$ git push --tags
$ rake release
```


## Commit documentation changes
```bash
$ cd doc/ && doxygen Doxyfile && cd ..
$ cd doc/html
$ git add .
$ git commit -v -m "Update docs ..."
Expand Down

0 comments on commit 438e563

Please sign in to comment.