A music player that connects to your cloud/distributed storage.
1Contributed by [@Netherquark](https://github.com/Netherquark)
2
3Hello there! I see you want to build Diffuse.
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 *nix systems, but it is still theoretically possible on Windows. </p>
6
7**Prerequisites for MacOS and Linux**
81. Curl
92. NodeJS/npm
103. Basic CLI operation knowledge
11
12**Linux guide** [Tested on Ubuntu 20.10]
131. Set up [Git](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/).
142. Install Nix using `curl -L https://nixos.org/nix/install | sh`
153. Reboot (recommended)
164. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse`
175. Navigate to the Diffuse folder using `cd diffuse`
186. Execute `nix-shell`
197. Execute `just install-deps` after the previous step finishes
208. Execute `just`
21
22**MacOS guide**
231. Set up [Git](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/).
242. Install Nix using `curl -L https://nixos.org/nix/install | sh`
253. Reboot (optional)
264. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse`
275. Navigate to the Diffuse folder using `cd diffuse`
286. Execute `nix-shell`
297. Execute `just install-deps` after the previous step finishes
308. Execute `just`
31
32**Prerequisites for Windows**
331. Git for Windows (https://gitforwindows.org/)
342. Haskell Tool Stack (https://docs.haskellstack.org/en/stable/install_and_upgrade/)
353. Basic CLI operation knowledge
364. `just` (https://github.com/casey/just#installation)
375. NodeJS (https://nodejs.org/en/download/)
386. NPM (https://pnpm.js.org/installation)
397. Elm (https://guide.elm-lang.org/install/elm.html)
40
41**Windows(native) guide(Untested)**
421. Install all the prerequisites and set them up.
432. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse`
443. Navigate to the Diffuse folder using `cd diffuse`
454. Execute `nix-shell`
465. Execute `just install-deps` after the previous step finishes
476. Execute `just`
48
49Note: _Using WSL/2 with the Linux instructions might work._
50
51In case you have any queries or issues, feel free to reach out to me @Netherquark or to Steven @icidasset.