tokono.ma / diffuse
A music player that connects to your cloud/distributed storage.
5
fork

Configure Feed

Select the types of activity you want to include in your feed.

update to compat.md & devguide.md (#311)

* Compatibility.md

* update to compat.md & devguide.md

* update to compat.md & devguide.md

authored by

Soham Kulkarni and committed by
GitHub 3f8f7472 c539013d

+43 -32
+17 -18
docs/Compatibility.md
··· 1 1 Contributed by [@Netherquark](https://github.com/Netherquark) 2 2 3 - | Platform | Browser | Installation | Website works? | Persistent Login? | Streaming | Caching | 4 - |:--------:|:-----------------:|:------------:|:--------------:|:-----------------:|:---------:|:-------:| 5 - | Windows | Chrome | ✅ | ✅ | ✅ | ✅ | ✅ | 6 - | | Edge(Legacy) | ❔ | ❔ | ❔ | ❔ | ❔ | 7 - | | Firefox | ✅ | ✅ | ✅ | ✅ | ❔ | 8 - | | Internet Explorer | ❔ | ❔ | ❔ | ❔ | ❔ | 9 - | MacOS | Chrome | ❔ | ❔ | ❔ | ❔ | ❔ | 10 - | | Firefox | ❔ | ❔ | ❔ | ❔ | ❔ | 11 - | | Safari | ❔ | ❔ | ❔ | ❔ | ❔ | 12 - | Manjaro | Chrome | ❔ | ❔ | ❔ | ❔ | ❔ | 13 - | | Firefox | ✅ | ✅ | ✅ | ✅ | ✅ | 14 - | Ubuntu | Chrome | ✅ | ✅ | ✅ | ✅ | ❌ | 15 - | | Firefox | ❔ | ❔ | ❔ | ❔ | ❔ | 16 - | Android | Chrome | ✅ | ✅ | ✅ | ✅ | ✅ | 17 - | | Firefox | ✅ | ✅ | ✅ | ✅ | ❌ | 18 - | iOS | Chrome | ❔ | ❔ | ❔ | ❔ | ❔ | 19 - | | Firefox | ❔ | ❔ | ❔ | ❔ | ❔ | 20 - | | Safari | ❔ | ❔ | ❔ | ❔ | ❔ | 3 + | Platform | Browser | Installation | Website works? | Persistent Login? | Streaming | Caching | Offline Login | 4 + |:--------:|:-----------------:|:------------:|:--------------:|:-----------------:|:---------:|:-------:|:-------------:| 5 + | Windows | Chromium | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | 6 + | | Firefox | ✅ | ✅ | ✅ | ✅ | ❔ | ❌ | 7 + | MacOS | Chromium | ❔ | ❔ | ❔ | ❔ | ❔ | ❔ | 8 + | | Firefox | ❔ | ❔ | ❔ | ❔ | ❔ | ❔ | 9 + | | Safari | ❔ | ❔ | ❔ | ❔ | ❔ | ❔ | 10 + | Linux | Chromium | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | 11 + | | Firefox | ❌* | ✅ | ✅ | ✅ | ✅ | ❌** | 12 + | Android | Chromium | ✅ | ✅ | ✅ | ✅ | ✅ | ❌** | 13 + | | Firefox | ✅ | ✅ | ✅ | ✅ | ✅ | ❌** | 14 + | iOS | Chromium | ❔ | ❔ | ❔ | ❔ | ❔ | ❔ | 15 + | | Firefox | ❔ | ❔ | ❔ | ❔ | ❔ | ❔ | 16 + | | Safari | ❔ | ❔ | ❔ | ❔ | ❔ | ❔ | 17 + 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/). 19 + **Diffuse loads, but with the "No tracks found" error
+26 -14
docs/Development Guide.md
··· 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 - <p> First off, determine your operating system (of choice). The setup process is considerably easier on MacOS and Linux, but it is still theoretically possible on Windows. </p> 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 - **Prerequisites for MacOS and Linux** 7 + **Prerequisites for MacOS and Linux** 8 8 1. Curl 9 9 2. Basic CLI operation knowledge 10 10 11 11 **Linux guide** [Tested on Ubuntu 20.10] 12 - 1. Set up Git. (https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/) 13 - 2. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse` 14 - 3. Install Nix using `curl -L https://nixos.org/nix/install | sh` 15 - 4. Reboot (recommended) 16 - 5. Navigate to the Diffuse folder using `cd` 12 + 1. Set up [Git](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/). 13 + 2. Install Nix using `curl -L https://nixos.org/nix/install | sh` 14 + 3. Reboot (recommended) 15 + 4. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse` 16 + 5. Navigate to the Diffuse folder using `cd diffuse` 17 17 6. Execute `nix-shell` 18 18 7. Execute `just install-deps` after the previous step finishes 19 - 8. Execute `just`. 20 - 9. ??? 19 + 8. Execute `just` 21 20 22 - **MacOS guide** 23 - lol idk maybe you write this? 21 + **MacOS guide** 22 + 1. Set up [Git](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/). 23 + 2. Install Nix using `curl -L https://nixos.org/nix/install | sh` 24 + 3. Reboot (optional) 25 + 4. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse` 26 + 5. Navigate to the Diffuse folder using `cd diffuse` 27 + 6. Execute `nix-shell` 28 + 7. Execute `just install-deps` after the previous step finishes 29 + 8. Execute `just` 24 30 25 - **Prerequisites for Windows** 31 + **Prerequisites for Windows** 26 32 1. Git for Windows (https://gitforwindows.org/) 27 33 2. Haskell Tool Stack (https://docs.haskellstack.org/en/stable/install_and_upgrade/) 28 34 3. Basic CLI operation knowledge ··· 31 37 6. NPM (https://pnpm.js.org/installation) 32 38 7. Elm (https://guide.elm-lang.org/install/elm.html) 33 39 34 - **Windows guide(Untested)** 40 + **Windows(native) guide(Untested)** 35 41 1. Install all the prerequisites and set them up. 36 - 2. ??? 42 + 2. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse` 43 + 3. Navigate to the Diffuse folder using `cd diffuse` 44 + 4. Execute `nix-shell` 45 + 5. Execute `just install-deps` after the previous step finishes 46 + 6. Execute `just` 47 + 48 + Note: _Using WSL/2 and the Linux instructions might work._ 37 49 38 50 In case you have any queries or issues, feel free to reach out to me @Netherquark or to Steven @icidasset.