Browse Source

Updated README.md

Phyks (Lucas Verney) 5 years ago
parent
commit
d895e80791
1 changed files with 31 additions and 17 deletions
  1. 31
    17
      README.md

+ 31
- 17
README.md View File

@@ -1,20 +1,34 @@
1 1
 Conway Game of Life
2 2
 ===================
3 3
 
4
-An implementation of the famous Game Of Life from Conway ( https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life ) in C. It uses ncurses to display a randomly generated view that follows the rules of the Game Of Life.
5
-
6
-LICENSE
7
-=======
8
-TLDR; I don't give a damn to anything you can do using this code. It would just be nice to
9
-quote where the original code comes from.
10
-
11
-
12
-* --------------------------------------------------------------------------------
13
-* "THE NO-ALCOHOL BEER-WARE LICENSE" (Revision 42):
14
-* Phyks (webmaster@phyks.me) wrote this file. As long as you retain this notice you
15
-* can do whatever you want with this stuff (and you can also do whatever you want
16
-* with this stuff without retaining it, but that's not cool...). If we meet some 
17
-* day, and you think this stuff is worth it, you can buy me a <del>beer</del> soda 
18
-* in return.
19
-*																		Phyks
20
-* ---------------------------------------------------------------------------------
4
+An implementation of the famous Game Of Life from Conway ( https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life ) in C. 
5
+
6
+It uses ncurses to display a randomly generated view that follows the rules of the Game Of Life.
7
+
8
+## Usage
9
+
10
+Just compile it using gcc with -ncurses argument :
11
+
12
+<code>gcc -ncurses main.c</code>
13
+
14
+Then, you can launch it with an argument giving the initial percentage of alive cells :
15
+
16
+<code>./a.out density</code> (where density is in [|0,100|])
17
+
18
+# LICENSE
19
+
20
+### TLDR;
21
+	I don't give a damn to anything you can do using this code. It would just be nice to
22
+	quote where the original code comes from.
23
+
24
+
25
+--------------------------------------------------------------------------------
26
+  	"THE NO-ALCOHOL BEER-WARE LICENSE" (Revision 42):
27
+  
28
+  	Phyks (phyks@phyks.me) wrote this file. As long as you retain this notice you
29
+ 	 can do whatever you want with this stuff (and you can also do whatever you want
30
+ 	 with this stuff without retaining it, but that's not cool... :/ ). If we meet some 
31
+ 	 day, and you think this stuff is worth it, you can buy me a <del>beer</del> soda 
32
+ 	 in return.
33
+  																			Phyks
34
+---------------------------------------------------------------------------------