diff --git a/README.md b/README.md index e0d41dd18dd9f..b278919b62876 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,92 @@ # Nextcloud Desktop Client -The :computer: Nextcloud Desktop Client is a tool to synchronize files from Nextcloud Server +The Nextcloud Desktop Client is a tool to synchronize files from Nextcloud Server with your computer. -## 📥 Download Binaries - -### https://github.com/nextcloud-releases/desktop/releases -

Desktop Client on Windows

-## :blue_heart: :tada: Contributing +## :blue_heart: Contributing -### :hammer_and_wrench: How to compile the desktop client +### Join the team 👪 +There are many ways to contribute, of which development is only one! Find out [how to get involved](https://nextcloud.com/contribute/), including as a translator, designer, tester, helping others, and much more! 😍 -:building_construction: [System requirements](https://github.com/nextcloud/desktop/wiki/System-requirements-for-compiling-the-desktop-client) includes OpenSSL 1.1.x, QtKeychain, Qt 5.x.x and zlib. +#### Help testing +- Download and install the client: + - [All releases](https://github.com/nextcloud-releases/desktop/releases) + - [Daily master builds](https://download.nextcloud.com/desktop/daily) +- Report issues at https://github.com/nextcloud/desktop/issues -#### :memo: Step by step instructions +#### Bug fixing and development +##### System requirements +- Windows 10, Windows 11, Mac OS > 10.14 or Linux -##### Clone the repo -``` -$ git clone https://github.com/nextcloud/desktop.git -$ cd desktop -``` -##### Compile and install +> [!NOTE] +> System requirements and instructions on how to work on Windows with KDE Craft you can find it at: https://github.com/nextcloud/desktop-client-blueprints/. -:warning: For development reasons it is better to **install the client on user space** instead on the global system. Mixing up libs/dll's of different version can lead to undefined behavior and crashes: +- Inkscape (to generate the icons): https://inkscape.org/release/i +- Developer tools: cmake, clang/gcc/g++: +- Qt6 since 3.14, Qt5 for earlier versions +- OpenSSL +- QtKeychain: https://github.com/frankosterfeld/qtkeychain +- SQLite -* You could use the **cmake flag** ```CMAKE_INSTALL_PREFIX``` as ```~/.local/``` in a **Linux** system. If you want to install system wide you could use ```/usr/local``` or ```/opt/nextcloud/```. +##### Optional +- [Qt Creator IDE](https://www.qt.io/product/development-tools) +- [delta: A viewer for git and diff output](https://github.com/dandavison/delta) -* On **Windows 10** [```$USERPROFILE```](https://docs.microsoft.com/en-us/windows/deployment/usmt/usmt-recognized-environment-variables#a-href-idbkmk-2avariables-that-are-recognized-only-in-the-user-context) refers to ```C:\Users\```. +> [!TIP] +> We highly recommend [Nextcloud development environment on Docker Compose](https://juliushaertl.github.io/nextcloud-docker-dev/) for testing/bug fixing/development.
+> ▶️ https://juliushaertl.github.io/nextcloud-docker-dev/ -##### Linux & Mac OS +#### General step by step instructions +1. Clone the repo ``` -$ cmake -S . -B build -DCMAKE_INSTALL_PREFIX=~/nextcloud-desktop-client -DCMAKE_BUILD_TYPE=Debug -$ cmake --build build --target install +git clone https://github.com/nextcloud/desktop.git ``` - -##### Windows - +2. Create ``` -$ cmake -S . -B build -G "Visual Studio 15 2017 Win64" -DCMAKE_INSTALL_PREFIX=$USERPROFILE\nextcloud-desktop-client -DCMAKE_BUILD_TYPE=Debug -$ cmake --build . --config Debug --target install +mkdir ``` +3. Compile -:information_source: More detailed instructions can be found at the [Desktop Client Wiki](https://github.com/nextcloud/desktop/wiki). - -### :inbox_tray: Where to find binaries to download - -#### :high_brightness: Daily builds - -- Daily builds based on the latest master are available for Linux :penguin:, Mac, and Windows -[in the desktop/daily folder of our download server](https://download.nextcloud.com/desktop/daily). -For more info: [Wiki/Daily Builds](https://github.com/nextcloud/desktop/wiki/Daily-Builds). +``` +cd +cmake -S -B build -DCMAKE_INSTALL_PREFIX= -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=. -DNEXTCLOUD_DEV=ON +``` -#### :rocket: Releases +> [!TIP] +> The cmake variabel NEXTCLOUD_DEV allows you to run your own build of the client while developing in parallel with an installed version of the client. -- Refer to the [download page https://nextcloud.com/install/#install-clients](https://nextcloud.com/install/#install-clients) +4. Build it +``` +cmake --build . +``` ### :bomb: Reporting issues - - If you find any bugs or have any suggestion for improvement, please -file an issue at https://github.com/nextcloud/desktop/issues. Do not -contact the authors directly by mail, as this increases the chance -of your report being lost. :boom: +file an issue at https://github.com/nextcloud/desktop/issues. ### :smiley: :trophy: Pull requests - - If you created a patch :heart_eyes:, please submit a [Pull Request](https://github.com/nextcloud/desktop/pulls). - How to create a pull request? This guide will help you get started: [Opening a pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) :heart: +#### :rocket: Releases +- For the latest stable recommended version, plrease refer to the [download page https://nextcloud.com/install/#install-clients](https://nextcloud.com/install/#install-clients) -## :satellite: Contact us +## Get in touch 💬 +* [📋 Forum](https://help.nextcloud.com) +* [👥 Facebook](https://www.facebook.com/nextclouders) +* [🐣 Twitter](https://twitter.com/Nextclouders) +* [🐘 Mastodon](https://mastodon.xyz/@nextcloud) -If you want to contact us, e.g. before starting a more complex feature, for questions :question: -you can join us at -[#nextcloud-client](https://webchat.freenode.net/?channels=nextcloud-client). +You can also [get support for Nextcloud](https://nextcloud.com/support)! ## :v: Code of conduct - -The Nextcloud community has core values that are shared between all members during conferences, hackweeks and on all interactions in online platforms including [Github](https://github.com/nextcloud) and [Forums](https://help.nextcloud.com). If you contribute, participate or interact with this community, please respect [our shared values](https://nextcloud.com/code-of-conduct/). :relieved: - -## :memo: Source code - -The Nextcloud Desktop Client is developed in Git. Since Git makes it easy to -fork and improve the source code and to adapt it to your need, many copies -can be found on the Internet, in particular on GitHub. However, the -authoritative repository maintained by the developers is located at -https://github.com/nextcloud/desktop. +Please read the [Code of Conduct](https://nextcloud.com/community/code-of-conduct/). This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere and to explain how together we can strengthen and support each other. ## :scroll: License