소스 검색

Update README.md

Kirill 11 년 전
부모
커밋
60d2333113
1개의 변경된 파일59개의 추가작업 그리고 99개의 파일을 삭제
  1. 59
    99
      README.md

+ 59
- 99
README.md 파일 보기

@@ -1,35 +1,12 @@
1
-	Netsukuku
2 1
 
3 2
 http://netsukuku.freaknet.org
4 3
 
5
---
6 4
 
7
-  1. What is this?
8
-  
9
-  2. Get the code!
10
-  
11
-  3. Build and install
12
- 
13
-   3.1 Static Binaries and Packages
14
-  
15
-  4. Kernel dependencies
16
-  
17
-  5. How to use it
18
-  
19
-  6. Where to get in touch with us
20
-  
21
-  7. Bug report
22
-  
23
-  8. Hack the code
24
-  
25
-  9. License and that kind of stuff...
26
-  
27
---
28
-
29
-
30
-**
31
-**** 1. What is this?
32
-**
5
+
6
+
7
+
8
+# What is this?
9
+
33 10
 
34 11
 Netsukuku is an alternative to the internet, It will have all of the features of the internet,
35 12
 Such as websites, Instant messaging, File transfers, DNS, Etc. It functions as a
@@ -62,25 +39,21 @@ Before doing anything, please read the documentation in doc/ or in
62 39
 http://netsukuku.freaknet.org
63 40
 
64 41
 
65
-**
66
-**** 2. Get the code!
67
-**
42
+# Get the code!
68 43
 
69
-$git clone git@github.com:Netsukuku/netsukuku.git 
70 44
 
45
+    $git clone git@github.com:Netsukuku/netsukuku.git 
71 46
 
72 47
 
48
+# Build and install
73 49
 
74
-**
75
-**** 3. Build and install
76
-**
77 50
 The dependencies of netsukuku can be gathered by running this command.
78 51
 
79
-# sudo apt-get install zlibc libgmp-dev openssl libgee-dev libpth-dev libgcrypt11-dev autoconf cmake autogen
52
+    # sudo apt-get install zlibc libgmp-dev openssl libgee-dev libpth-dev libgcrypt11-dev autoconf cmake autogen
80 53
 
81 54
 To compile the code you can use scons or just go with the old school way:
82 55
 
83
-# ./configure && make && make install
56
+    # ./configure && make && make install
84 57
 
85 58
 But SCons is cooler:
86 59
 http://www.scons.org/
@@ -97,16 +70,17 @@ the openssl library here: http://openssl.org
97 70
 and finally the zlibs: http://zlib.net
98 71
 
99 72
 Then go in the src/ directory and type:
100
-$ scons --help
73
+    
74
+    $ scons --help
101 75
 
102 76
 That will show you all the options you can use in the build and installation
103 77
 process. Finally execute:
104 78
 
105
-$ scons
79
+    $ scons
106 80
 
107 81
 The code will be compiled. If all went well install NetsukukuD with:
108 82
 
109
-# scons install
83
+    # scons install
110 84
 
111 85
 Now you should give a look at /etc/netsukuku.conf (or wherever you installed
112 86
 it) and modify it for your needs, but generally the default options are good.
@@ -115,12 +89,11 @@ it) and modify it for your needs, but generally the default options are good.
115 89
 
116 90
 If you want to change some scons option to do another installation, (i.e. you
117 91
 may want to reinstall it with another MANDIR path), you have to run:
118
-$ scons --clean
119 92
 
93
+    $ scons --clean
120 94
 
121
-**
122
-**** 3.1 Static Binaries and Packages
123
-**
95
+
96
+# Static Binaries and Packages
124 97
 
125 98
 If you prefer to just install Netsukuku, without compiling it, you can
126 99
 download the static binaries suitable to your platform. They come packed in
@@ -133,64 +106,58 @@ The packages repository is at:
133 106
     (This archive contains unoffical packages, However, They have been tested, And function on Ubuntu 12.04 and earlier.)
134 107
 
135 108
 
136
-**
137
-**** 4. Kernel dependencies
138
-**
109
+# Kernel dependencies
110
+
139 111
 
140 112
 (The following probably is already, If not will be soon, Unnecessary/automated.)
141 113
 
142 114
 On Linux be sure to have the following options set in your kernel .config.
143 115
 These options are taken from linux-2.6.14.
144 116
  
145
-#
146
-# Networking options
147
-#
148
-CONFIG_PACKET=y
149
-CONFIG_UNIX=y
150
-CONFIG_INET=y
151
-CONFIG_IP_MULTICAST=y
152
-CONFIG_IP_ADVANCED_ROUTER=y
153
-CONFIG_IP_MULTIPLE_TABLES=y
154
-CONFIG_IP_ROUTE_MULTIPATH=y
155
-CONFIG_NET_IPIP=y
156
-CONFIG_NETFILTER=y
117
+
118
+ Networking options
119
+
120
+    CONFIG_PACKET=y
121
+    CONFIG_UNIX=y
122
+    CONFIG_INET=y
123
+    CONFIG_IP_MULTICAST=y
124
+    CONFIG_IP_ADVANCED_ROUTER=y
125
+    CONFIG_IP_MULTIPLE_TABLES=y
126
+    CONFIG_IP_ROUTE_MULTIPATH=y
127
+    CONFIG_NET_IPIP=y
128
+    CONFIG_NETFILTER=y
157 129
 
158 130
 and these from linux-2.6.16.19.
159 131
 
160
-#
161
-# Core Netfilter Configuration
162
-#
132
+ Core Netfilter Configuration
163 133
 
164
-CONFIG_NETFILTER_XT_MATCH_CONNTRACK=y
165
-NETFILTER_XT_TARGET_CONNMARK=y
134
+    CONFIG_NETFILTER_XT_MATCH_CONNTRACK=y
135
+    NETFILTER_XT_TARGET_CONNMARK=y
166 136
 
167
-#
168
-# IP: Netfilter Configuration
169
-#
137
+ IP: Netfilter Configuration
170 138
 
171
-CONFIG_IP_NF_IPTABLES=y
172
-CONFIG_IP_NF_FILTER=y
173
-CONFIG_IP_NF_TARGET_REJECT=y
174
-CONFIG_IP_NF_NAT=y
175
-CONFIG_IP_NF_NAT_NEEDED=y
176
-CONFIG_IP_NF_TARGET_MASQUERADE=y
139
+    CONFIG_IP_NF_IPTABLES=y
140
+    CONFIG_IP_NF_FILTER=y
141
+    CONFIG_IP_NF_TARGET_REJECT=y
142
+    CONFIG_IP_NF_NAT=y
143
+    CONFIG_IP_NF_NAT_NEEDED=y
144
+    CONFIG_IP_NF_TARGET_MASQUERADE=y
177 145
 
178 146
 If you are using modules you have to load them before launching the daemon.
179 147
 
180 148
 
181
-**
182
-**** 5. How to use it
183
-**
149
+# How to use it
150
+
184 151
 
185 152
 Before doing anything do:
186 153
 
187
-$ man ntkd
188
-$ man andna
154
+    $ man ntkd
155
+    $ man andna
189 156
 
190 157
 when you feel confortable and you are ready to dare type with root
191 158
 priviledges:
192 159
 
193
-# ntkd
160
+    # ntkd
194 161
 
195 162
 then just wait... ^_-
196 163
 
@@ -203,49 +170,44 @@ to force the daemon to use specific interfaces you should use the B<-i>
203 170
 option.
204 171
 
205 172
 
206
-**
207
-**** 6. Where to get in touch with us
208
-**
173
+# Where to get in touch with us
209 174
 
210
-> Mailing list
175
+## Mailing list
211 176
 
212 177
 Subscribe to the netsukuku mailing to get help, be updated on the latest news
213 178
 and discuss on its development.
214 179
 
215 180
 To subscribe to the list, send a message to:
216
-    netsukuku-subscribe@lists.dyne.org
181
+  netsukuku-subscribe@lists.dyne.org
217 182
 or use the web interface:
218
-    http://lists.dyne.org/mailman/listinfo/netsukuku
183
+  http://lists.dyne.org/mailman/listinfo/netsukuku
219 184
    
220 185
 You can browse the archive here:
221
-    http://lists.dyne.org/netsukuku/
222
-    http://dir.gmane.org/gmane.network.peer-to-peer.netsukuku
186
+  http://lists.dyne.org/netsukuku/
187
+  http://dir.gmane.org/gmane.network.peer-to-peer.netsukuku
223 188
  
224 189
 
225
-> IRC
190
+## IRC
226 191
 
227 192
 We live night and day in IRC, come to see us on channel
228 193
    #netsukuku
229 194
 on the FreeNode irc server (irc.freenode.org).
230 195
 
231 196
 
232
-**
233
-**** 7. Bug report
234
-**
197
+# Bug report
198
+
235 199
 
236 200
 { Don't panic! }
237 201
 
238 202
 If you encounter any bug, please report it.
239 203
 Use the online bug track system:
240
-    http://bugs.dyne.org/
204
+  http://bugs.dyne.org/
241 205
 or the mailing list:
242
-    http://lists.dyne.org/netsukuku/
206
+  http://lists.dyne.org/netsukuku/
243 207
 and explain what the problem is and if possible a way to reproduce it.
244 208
 
245 209
 
246
-**
247
-**** 8. Hack the code
248
-**
210
+# Hack the code
249 211
 
250 212
 Feel free to debug, patch, modify and eat the code. Then submit your results
251 213
 to the mailing list ^_-
@@ -255,9 +217,7 @@ help the development writing some nice poems. For a start you can take a look
255 217
 at the src/TODO file.
256 218
 
257 219
 
258
-**
259
-**** 9. License and that kind of stuff...
260
-**
220
+# License and that kind of stuff...
261 221
 
262 222
 All the Netsukuku code is released under the GPL-2, please see the COPYING
263 223
 file for more information.

Loading…
취소
저장