forked from
tokono.ma/diffuse
A music player that connects to your cloud/distributed storage.
Development_guide.md (#276)
authored by
Soham Kulkarni
and committed by
GitHub
7a36da87
5b665c7e
+36
+36
Development_guide.md
+36
Development_guide.md
···
1
+
Hello there! I see you want to build Diffuse.
2
+
<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>
3
+
<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>
4
+
5
+
**Prerequisites for MacOS and Linux**
6
+
1. Curl
7
+
2. Basic CLI operation knowledge
8
+
9
+
**Linux guide** [Tested on Ubuntu 20.10]
10
+
1. Set up Git. (https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/)
11
+
2. Clone Diffuse with `git clone https://www.github.com/icidasset/diffuse`
12
+
3. Install Nix using `curl -L https://nixos.org/nix/install | sh`
13
+
4. Reboot (recommended)
14
+
5. Navigate to the Diffuse folder using `cd`
15
+
6. Execute `nix-shell`
16
+
7. Execute `just install-deps` after the previous step finishes
17
+
8. Execute `just`.
18
+
9. ???
19
+
20
+
**MacOS guide**
21
+
lol idk maybe you write this?
22
+
23
+
**Prerequisites for Windows**
24
+
1. Git for Windows (https://gitforwindows.org/)
25
+
2. Haskell Tool Stack (https://docs.haskellstack.org/en/stable/install_and_upgrade/)
26
+
3. Basic CLI operation knowledge
27
+
4. `just` (https://github.com/casey/just#installation)
28
+
5. NodeJS (https://nodejs.org/en/download/)
29
+
6. NPM (https://pnpm.js.org/installation)
30
+
7. Elm (https://guide.elm-lang.org/install/elm.html)
31
+
32
+
**Windows guide(Untested)**
33
+
1. Install all the prerequisites and set them up.
34
+
2. ???
35
+
36
+
In case you have any queries or issues, feel free to reach out to me @Netherquark or to Steven @icidasset.