Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredhanson committed May 11, 2013
1 parent eee91d9 commit 1090e91
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
doc/qtxupdate/

# Mac OS X
.DS_Store

Expand Down
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,19 @@ QtxUpdate provides classes to make software update checks easier, including
support for [appcasting](http://connectedflow.com/appcasting/) with [Sparkle](http://sparkle.andymatuschak.org/)
[extensions](https://github.com/andymatuschak/Sparkle/wiki/Publishing-An-Update).

## Tests
## Build

To build a dynamic library:

$ qmake CONFIG+=dylib
$ make

To build a static library:

$ qmake CONFIG+=static
$ make

## Test

To run the test suite, first configure and build QtxUpdate as a dynamic
library, which each test executable will link against. Then invoke the `check`
Expand All @@ -14,6 +26,16 @@ target to execute all tests in the suite.
$ make
$ make check

## Documentation

To generate API documentation, invoke the `docs` target.

$ make docs

To view the documentation, open it in a web browser.

$ open doc/qtxupdate/qtxupdate-module.html

## License

[Apache License, Version 2.0](http://opensource.org/licenses/Apache-2.0)
Expand Down
2 changes: 1 addition & 1 deletion modules/qtx_update.pri
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ QTX.update.VERSION = $${QTX.update.MAJOR_VERSION}.$${QTX.update.MINOR_VERSION}.$
QTX.update.name = QtxUpdate
QTX.update.bins = $$PWD/../bin
QTX.update.includes = $$PWD/../include
QTX.update.sources = $$PWD/../src/version
QTX.update.sources = $$PWD/../src/update
QTX.update.libs = $$PWD/../lib
QTX.update.plugins = $$PWD/../plugins
QTX.update.imports = $$PWD/../imports

0 comments on commit 1090e91

Please sign in to comment.