diff --git a/README b/README deleted file mode 100644 index 2d490bf..0000000 --- a/README +++ /dev/null @@ -1,39 +0,0 @@ -LibKGAPI -======================== - -LibKGAPI (previously called LibKGoogle) is a C++ library that implements APIs for -various Google services. - -Currently supported APIs: - - Calendar API v3 (https://developers.google.com/google-apps/calendar) - - Contacts API v3 (https://developers.google.com/google-apps/contacts/v3/) - - Tasks API v1 (https://developers.google.com/google-apps/tasks) - - Static Google Maps API v2 (https://developers.google.com/maps/documentation/staticmaps/) - - Drive API v2 (https://developers.google.com/drive/v2/reference) - - Blogger API v3 (https://developers.google.com/blogger/docs/3.0/reference/) - -Deprecated APIs: - - Latitude API v1 (https://developers.google.com/latitude/v1/) - -Compiling: ----------- - - mkdir build - cd build - cmake ../ -DCMAKE_INSTALL_PREFIX=/usr - make - # As root: - make install - -To compile example applications, run cmake with -DKGAPI_BUILD_EXAMPLES=TRUE argument. -To compile automated tests, run 'make buildtests'. To run automated tests, run 'make test' - -BUGS: ------ -Submit bugs and feature requests to KDE bugzilla, product libkgapi: - -https://bugs.kde.org/enter_bug.cgi?product=libkgapi - -API Documentation: ------------------- -http://api.kde.org/extragear-api/libs-apidocs/libkgapi/html/index.html diff --git a/README.md b/README.md new file mode 100644 index 0000000..995032e --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# LibKGAPI + +LibKGAPI (previously called LibKGoogle) is a C++ library that implements APIs for +various Google services. + +Currently supported APIs: + * Calendar API v3 (https://developers.google.com/google-apps/calendar) + * Contacts API v3 (https://developers.google.com/google-apps/contacts/v3/) + * Tasks API v1 (https://developers.google.com/google-apps/tasks) + * Static Google Maps API v2 (https://developers.google.com/maps/documentation/staticmaps/) + * Drive API v2 (https://developers.google.com/drive/v2/reference) + * Blogger API v3 (https://developers.google.com/blogger/docs/3.0/reference/) + +Deprecated APIs: + * Latitude API v1 (https://developers.google.com/latitude/v1/) + +## Compiling: + +``` +mkdir build +cd build +cmake ../ -DCMAKE_INSTALL_PREFIX=/usr +make +# As root: +make install +``` + +To compile example applications, run cmake with `-DKGAPI_BUILD_EXAMPLES=TRUE` argument. +To run automated tests, run `make test`. + +## BUGS: + +Submit bugs and feature requests to KDE bugzilla, product libkgapi: + +https://bugs.kde.org/enter_bug.cgi?product=libkgapi + +## API Documentation: + +https://api.kde.org/kdepim/libkgapi/html/index.html