Bladeren bron

[back][doc] add README

Mukhamed Karanashev 7 jaren geleden
bovenliggende
commit
1b71249a6f
1 gewijzigde bestanden met toevoegingen van 60 en 0 verwijderingen
  1. 60 0
      back/README.md

+ 60 - 0
back/README.md

@@ -0,0 +1,60 @@
+## Installation for complete newbies like me
+
+### Linux
+
+#### Clone this repo
+``` bash
+$ git clone https://gogs.enikesha.net/chad-partners/chad-music.git
+```
+
+#### Clone taglib dependency
+``` bash
+$ git clone https://gogs.enikesha.net/chad-partners/taglib.git
+```
+
+#### Install libev
+
+__Ubuntu__
+``` bash
+$ sudo apt install libev4
+```
+
+#### Install roswell 
+
+[Roswell](https://github.com/roswell/roswell) is a tool to manage Common Lisp environments
+
+__Ubuntu__
+Download and install latest deb package from [Releases page](https://github.com/roswell/roswell/releases)
+
+__Mac OS X__
+Use homebrew:
+``` bash
+$ brew install roswell
+```
+
+#### Check that roswell REPL is working
+``` bash
+$ ros run
+* (exit)
+$
+```
+
+#### Install local dependencies
+
+You have to link your projects (chad-music backend and taglib) to local repo:
+``` bash
+$ ln -s ~/<path>/<to>/<chad-music>/chad-music/back ~/.roswell/local-projects/chad-music
+$ ln -s ~/<path>/<to>/<taglib>/taglib ~/.roswell/local-projects/taglib
+```
+
+#### Run emacs with chad-music project
+``` bash
+$ ros emacs
+```
+
+Then within emacs run Slime with `M-x slime` and load chad-music: 
+```
+CL-USER> (ql:quickload :chad-music)
+```
+
+Hope that everything loads without problems.