summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichael Meeks <michael.meeks@collabora.com>2020-10-01 15:21:53 +0100
committerMichael Meeks <michael.meeks@collabora.com>2020-10-01 15:22:02 +0100
commit4c1144583bea8b229ae30170f2b4f54606243ad5 (patch)
tree98eeead48a232cc80914eedab88a754ba49b5750 /README.md
parentMarkdown is the future. (diff)
downloadonline-4c1144583bea8b229ae30170f2b4f54606243ad5.tar.gz
online-4c1144583bea8b229ae30170f2b4f54606243ad5.zip
Switch to markdown.
Change-Id: Ica64c0c010d43d5a529cd3f2dcf3a18c688e8366
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 26 insertions, 17 deletions
diff --git a/README.md b/README.md
index 06802aad00..7021a3812e 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,37 @@
-Collabora Online.
+# Collabora Online.
+
+## Website
+
+For many more details, build instructions, downloads and more please see https://collaboraonline.github.io/
+
+Or ask questions on irc.freenode.net in #cool-dev or on our https://forum.collaboraonline.com/
+
+## Develoment bits
This project has several components:
-wsd/
- The Web Services Daemon - which accepts external connections.
+### wsd/
+
+The Web Services Daemon - which accepts external connections.
-kit/
- The client which lives in its own chroot and renders documents.
+### kit/
+The client which lives in its own chroot and renders documents.
-common/
- Shared code between these processes.
+### common/
+Shared code between these processes.
-loleaflet/
- The client side JavaScript component.
+### loleaflet/
+The client side JavaScript component.
-test/
- C++ based unit tests.
+### test/
+C++ based unit tests.
-cypress_test/
- JavaScript based integration tests.
+### cypress_test/
+JavaScript based integration tests.
-It is recommended to read these files:
+## Further recommended reading with build details:
- wsd/README
- loleaflet/README
+wsd/README
+loleaflet/README
-Enjoy.
+## Enjoy.