-18

docs/Compatibility.md

reviewed

··· 1 1 - Contributed by [@Netherquark](https://github.com/Netherquark) 2 2 - 3 3 - | Platform | Browser | Installation | Website works? | Persistent Login? | Streaming | Caching | 4 4 - |:--------:|:-----------------:|:------------:|:--------------:|:-----------------:|:---------:|:-------:| 5 5 - | Windows | Chromium | ✅ | ✅ | ✅ | ✅ | ✅ | 6 6 - | | Firefox | ✅ | ✅ | ✅ | ✅ | ❔ | 7 7 - | MacOS | Chromium | ❔ | ❔ | ❔ | ❔ | ❔ | 8 8 - | | Firefox | ❔ | ❔ | ❔ | ❔ | ❔ | 9 9 - | | Safari | ❔ | ❔ | ❔ | ❔ | ❔ | 10 10 - | Linux | Chromium | ✅ | ✅ | ✅ | ✅ | ✅ | 11 11 - | | Firefox | ❌* | ✅ | ✅ | ✅ | ✅ | 12 12 - | Android | Chromium | ✅ | ✅ | ✅ | ✅ | ✅ | 13 13 - | | Firefox | ✅ | ✅ | ✅ | ✅ | ✅ | 14 14 - | iOS | Chromium | ❔ | ❔ | ❔ | ❔ | ❔ | 15 15 - | | Firefox | ❔ | ❔ | ❔ | ❔ | ❔ | 16 16 - | | Safari | ❔ | ❔ | ❔ | ❔ | ❔ | 17 17 - 18 18 - *Diffuse works as expected but Firefox doesn't support "installing" PWAs. More about this topic [here](https://www.xda-developers.com/mozilla-drops-support-for-desktop-web-apps-in-firefox/).

-51

docs/Development Guide.md

reviewed

··· 1 1 - Contributed by [@Netherquark](https://github.com/Netherquark) 2 2 - 3 3 - Hello there! I see you want to build Diffuse. 4 4 - <p> The process can seem quite complicated, especially if you aren't familiar with concepts like Nix, just like I wasn't when I started out. Don't worry, this guide is here to help you. </p> 5 5 - <p> First off, determine your operating system (of choice). The setup process is considerably easier on *nix systems, but it is still theoretically possible on Windows. </p> 6 6 - 7 7 - **Prerequisites for MacOS and Linux** 8 8 - 1. Curl 9 9 - 2. NodeJS/npm 10 10 - 3. Basic CLI operation knowledge 11 11 - 12 12 - **Linux guide** [Tested on Ubuntu 20.10] 13 13 - 1. Set up [Git](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/). 14 14 - 2. Install Nix using `curl -L https://nixos.org/nix/install | sh` 15 15 - 3. Reboot (recommended) 16 16 - 4. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse` 17 17 - 5. Navigate to the Diffuse folder using `cd diffuse` 18 18 - 6. Execute `nix-shell` 19 19 - 7. Execute `just install-deps` after the previous step finishes 20 20 - 8. Execute `just` 21 21 - 22 22 - **MacOS guide** 23 23 - 1. Set up [Git](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/). 24 24 - 2. Install Nix using `curl -L https://nixos.org/nix/install | sh` 25 25 - 3. Reboot (optional) 26 26 - 4. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse` 27 27 - 5. Navigate to the Diffuse folder using `cd diffuse` 28 28 - 6. Execute `nix-shell` 29 29 - 7. Execute `just install-deps` after the previous step finishes 30 30 - 8. Execute `just` 31 31 - 32 32 - **Prerequisites for Windows** 33 33 - 1. Git for Windows (https://gitforwindows.org/) 34 34 - 2. Haskell Tool Stack (https://docs.haskellstack.org/en/stable/install_and_upgrade/) 35 35 - 3. Basic CLI operation knowledge 36 36 - 4. `just` (https://github.com/casey/just#installation) 37 37 - 5. NodeJS (https://nodejs.org/en/download/) 38 38 - 6. NPM (https://pnpm.js.org/installation) 39 39 - 7. Elm (https://guide.elm-lang.org/install/elm.html) 40 40 - 41 41 - **Windows(native) guide(Untested)** 42 42 - 1. Install all the prerequisites and set them up. 43 43 - 2. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse` 44 44 - 3. Navigate to the Diffuse folder using `cd diffuse` 45 45 - 4. Execute `nix-shell` 46 46 - 5. Execute `just install-deps` after the previous step finishes 47 47 - 6. Execute `just` 48 48 - 49 49 - Note: _Using WSL/2 with the Linux instructions might work._ 50 50 - 51 51 - In case you have any queries or issues, feel free to reach out to me @Netherquark or to Steven @icidasset.