source: docs/DIRECTORIES.md @ 18b11d2

Last change on this file since 18b11d2 was 18b11d2, checked in by meeh <meeh@…>, 2 years ago

Reducing the amount of "items" in the root of the repo
by moving documents into a own docs directory.

  • Property mode set to 100644
File size: 2.0 KB
Line 
1# Short directory explaination
2
3This list should give any new developer a kickstart in where to find code that they wish to modify.
4
5Also nice for old developers with weak memory :)
6
7Directory | Description
8 -------  |  ---------
9`apps` | This directory contains applications and clients that ships with i2p.
10`apps/addressbook` | Some headless code for addressbook management.
11`apps/apparmor` | Ruleset for AppArmor.
12`apps/BOB` | Code for the BOB service.
13`apps/i2psnark` | Code for i2psnark, the torrent client component in webconsole.
14`apps/i2ptunnel` | Code for the Hidden Service Manager, and it's GUI in webconsole.
15`apps/jetty` | Jetty webserver code.
16`apps/routerconsole` | The router console code.
17`apps/sam` | SAM service.
18`apps/streaming` | The streaming part.
19`apps/susidns` | Code for the addressbook component in the webconsole.
20`apps/susimail` | Code for the mail client component in the webconsole.
21`installer` | This directory contains the code for the installer.
22`installer/resources` | Used for static files that's packed with i2p.
23`core/java` | Common core code used both by the rotuer and apps.
24`core/java/src/net/i2p/app` | Code for app interface.
25`core/java/src/net/i2p/crypto` | This directory contain most of the crypto code.
26`core/java/src/net/i2p/client` | Client interface code (I2PClient, I2PSession etc.).
27`core/java/src/net/i2p/socks` | SOCKS implementation.
28`core/java/src/net/i2p/update` | Parts of the update code.
29`core/java/src/net/i2p/util` | Utillity code like Log, FileUtil, EepGet, HexDump, and so on.
30`router/java` | This directory contains the I2P router code.
31`router/java/src/net/i2p/data/i2np` | I2NP code, the inner protocol for I2P.
32`router/java/src/net/i2p/router/startup` | Code related to the startup sequence.
33`router/java/src/net/i2p/router/networkdb/kademlia` | The DHT (kademlia) code.
34`router/java/src/net/i2p/router/networkdb/reseed` | The reseed code.
35`router/java/src/net/i2p/router/transport` | Transport implementation code (NTCP, SSU).
36`router/java/src/net/i2p/router/tunnel` | Tunnel implementation code.
37
38 
Note: See TracBrowser for help on using the repository browser.