=== INSTALLATION ===

Please see our wiki for an excellent installation guide : https://github.com/Cairo-Dock/cairo-dock-core/wiki/Installation

The stable version can be installed from our PPA: https://launchpad.net/~cairo-dock-team/+archive/ppa

The latest development version is also available: https://launchpad.net/~cairo-dock-team/+archive/weekly

If you prefer to compile from source, you can download from GitHub:
  - Cairo-Dock-Core (the minimal - https://github.com/Cairo-Dock/cairo-dock-core)
  - Cairo-Dock-Plug-ins (a collection of views, applets, animations, effects, etc. - https://github.com/Cairo-Dock/cairo-dock-plug-ins)
  - Cairo-Dock-Plug-ins-Extras (a collection of third-party applets written in any language - https://github.com/Cairo-Dock/cairo-dock-plug-ins-extras)
You can find more information on compiling here: https://github.com/Cairo-Dock/cairo-dock-core/wiki/Compiling-from-source

=== NEED SOME HELP ? ===

See our wiki ! https://github.com/Cairo-Dock/cairo-dock-core/wiki
You can find : how to launch the dock at startup, how to customise it, how to resolve some recurrent problems (black background, messages at startup, etc.) , how to help us, who we are, etc.
A useful tutorial is also available to help you get started with customizing your dock: https://github.com/Cairo-Dock/cairo-dock-core/wiki/Configuration

If you have other questions not solved on our wiki you can post them on our GitHub discussions page:
https://github.com/Cairo-Dock/cairo-dock-core/discussions

=== JOIN THE PROJECT ! ===

* Want to HACK into the dock or write an APPLET ? see the complete C API here : https://github.com/Cairo-Dock/glxdock-repository/blob/main/docs/refman_3.6.pdf
* You don't like C and still want to write an APPLET for the dock or CONTROL it from a script or the terminal ? see its powerful DBus API here : https://github.com/Cairo-Dock/cairo-dock-core/wiki/Writing-an-applet
* You have some IDEAS / PROPOSITIONS ? You need some help to develop an applet ? Feel free post a topic on our GitHub issue tracker: https://github.com/Cairo-Dock/cairo-dock-core/issues
* You want to TRANSLATE Cairo-Dock in your language ? Use the 'Translations' tab in Launchpad, it's very simple to use it and helpful for us !

=== BUG REPORTS ===

The preferred way to report bugs is to use our GitHub issue tracker: https://github.com/Cairo-Dock/cairo-dock-core/issues (bugs on Launchpad are only checked sporadically). If possible:
 * Read our wiki : specially the 'Troubleshooting' section : https://github.com/Cairo-Dock/cairo-dock-core/wiki/Troubleshooting (which can help you to resolve some bug like a black background, messages at startup, etc.)
 * Please include also some information like your distribution, your Desktop Manager (Gnome, KDE, XFCE,...) your Window Manager (Compiz, Metacity, Kwin, etc.), if you use Cairo-Dock with or without OpenGL, with which theme, etc. On recent versions of Cairo-dock, a lot of useful information is provided on the 'Technical info' tab of the about dialog (available by right clicking anywhere and pointing to the "Cairo-Dock" submenu and then selecting "About")
* Include the method to reproduce the bug (which actions, which options activated)
* Run the dock with the command
          cairo-dock -l debug > debug.txt
       reproduce the bug and join the content of debug.txt.
* If it's a crash and you know how to use a debugger (like gdb), it's extremely helpful.

Thanks for your help !