Browse Source

Add a README file

Yann Weber 5 years ago
parent
commit
1e56db75c7
1 changed files with 41 additions and 0 deletions
  1. 41
    0
      README

+ 41
- 0
README View File

@@ -0,0 +1,41 @@
1
+yaglitch : Yet Another Glitch implementation
2
+============================================
3
+
4
+From an original idead from https://github.com/erlehmann/libglitch
5
+
6
+Glitch file format is documented in FORMAT-draft-erlehmann copied from the
7
+repo above.
8
+
9
+Compiling :
10
+===========
11
+
12
+Needs : nasm, GNU ld, GNU make
13
+-------
14
+Depends : on SDL (1 or 2) headers (libsdl1.2-dev or libsdl2-dev on Debian)
15
+---------
16
+
17
+To compile for SDL1 use : 
18
+
19
+$ make
20
+	or
21
+$ SDL=1 make
22
+
23
+To compile for SDL2 use :
24
+
25
+$ SDL=2 make
26
+
27
+Then you can run yaglitch : 
28
+
29
+$ ./yaglitch # to get some help
30
+$ ./yaglitch zered1.glitch # to run a test glitch
31
+
32
+Other songs examples :
33
+======================
34
+
35
+You can find various example song on
36
+https://github.com/erlehmann/libglitch/tree/master/tracks
37
+
38
+But it is better to write your own ;o)
39
+
40
+Note that the python implementation from erlehmann has a fancy GUI to edit
41
+your song live !

Loading…
Cancel
Save