Adding project to GIT
[froff-onlinedoc] / README
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..0e57bdf
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@
+Build Instructions
+******************
+Plugin can be built only on maemo as there are dependencies on QtMaemo libraries. Therefore, no more standalone support.
+To build it use Scratchbox or the Nokia Qt SDK.
+
+Features
+********
+SlideShare:
+> Supports download of all uploaded files in the format they were uploaded. Only file available for download are allowed for download.
+> Upload formats: Documents      odt, doc
+                  Spreadsheet    ods, xls
+                  Presentation   odp, ppt
+
+Google Documents:
+> Download formats: Documents      odt
+                    Spreadsheet    ods
+                    Presentation   odp
+                    Others         In the format they were uploaded
+> Upload formats: Documents      odt, doc
+                  Spreadsheet    ods, xls
+                  Presentation   ppt
+                  Others         No support yet
+
+Current Issues
+**************
+1) Sometimes uploads to GoogleDocuments fail because of a internal server error. If that happens try uploading again.
+2) Upload of "ods" spreadsheets to Google Documents always fails. So it has been disabled.
+
+
+Contact
+*******
+If you have any issues contact me at: kshlmster at gmail dot com