diff --git a/docs/Compatibility.md b/docs/Compatibility.md deleted file mode 100644 index 93492dd2..00000000 --- a/docs/Compatibility.md +++ /dev/null @@ -1,18 +0,0 @@ -Contributed by [@Netherquark](https://github.com/Netherquark) - -| Platform | Browser | Installation | Website works? | Persistent Login? | Streaming | Caching | -|:--------:|:-----------------:|:------------:|:--------------:|:-----------------:|:---------:|:-------:| -| Windows | Chromium | ✅ | ✅ | ✅ | ✅ | ✅ | -| | Firefox | ✅ | ✅ | ✅ | ✅ | ❔ | -| MacOS | Chromium | ❔ | ❔ | ❔ | ❔ | ❔ | -| | Firefox | ❔ | ❔ | ❔ | ❔ | ❔ | -| | Safari | ❔ | ❔ | ❔ | ❔ | ❔ | -| Linux | Chromium | ✅ | ✅ | ✅ | ✅ | ✅ | -| | Firefox | ❌* | ✅ | ✅ | ✅ | ✅ | -| Android | Chromium | ✅ | ✅ | ✅ | ✅ | ✅ | -| | Firefox | ✅ | ✅ | ✅ | ✅ | ✅ | -| iOS | Chromium | ❔ | ❔ | ❔ | ❔ | ❔ | -| | Firefox | ❔ | ❔ | ❔ | ❔ | ❔ | -| | Safari | ❔ | ❔ | ❔ | ❔ | ❔ | - -*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/). diff --git a/docs/Development Guide.md b/docs/Development Guide.md deleted file mode 100644 index 1426a1ba..00000000 --- a/docs/Development Guide.md +++ /dev/null @@ -1,51 +0,0 @@ -Contributed by [@Netherquark](https://github.com/Netherquark) - -Hello there! I see you want to build Diffuse. -

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.

-

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.

- -**Prerequisites for MacOS and Linux** -1. Curl -2. NodeJS/npm -3. Basic CLI operation knowledge - -**Linux guide** [Tested on Ubuntu 20.10] -1. Set up [Git](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/). -2. Install Nix using `curl -L https://nixos.org/nix/install | sh` -3. Reboot (recommended) -4. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse` -5. Navigate to the Diffuse folder using `cd diffuse` -6. Execute `nix-shell` -7. Execute `just install-deps` after the previous step finishes -8. Execute `just` - -**MacOS guide** -1. Set up [Git](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/). -2. Install Nix using `curl -L https://nixos.org/nix/install | sh` -3. Reboot (optional) -4. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse` -5. Navigate to the Diffuse folder using `cd diffuse` -6. Execute `nix-shell` -7. Execute `just install-deps` after the previous step finishes -8. Execute `just` - -**Prerequisites for Windows** -1. Git for Windows (https://gitforwindows.org/) -2. Haskell Tool Stack (https://docs.haskellstack.org/en/stable/install_and_upgrade/) -3. Basic CLI operation knowledge -4. `just` (https://github.com/casey/just#installation) -5. NodeJS (https://nodejs.org/en/download/) -6. NPM (https://pnpm.js.org/installation) -7. Elm (https://guide.elm-lang.org/install/elm.html) - -**Windows(native) guide(Untested)** -1. Install all the prerequisites and set them up. -2. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse` -3. Navigate to the Diffuse folder using `cd diffuse` -4. Execute `nix-shell` -5. Execute `just install-deps` after the previous step finishes -6. Execute `just` - -Note: _Using WSL/2 with the Linux instructions might work._ - -In case you have any queries or issues, feel free to reach out to me @Netherquark or to Steven @icidasset.