From f7883ed1b3c2cd799035e7b79f2c47f2ebc98e2a Mon Sep 17 00:00:00 2001 From: Jon Choi Date: Fri, 7 Jul 2017 15:41:10 -0700 Subject: [PATCH] README.md: Notes on where to start reading code Based on response from @whyrusleeping. (https://github.com/ipfs/go-ipfs/issues/4048#issuecomment-313774707) License: MIT Signed-off-by: Jon Choi --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index bf3d4c41a..d7f1edaf3 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ Please put all issues regarding the Go IPFS _implementation_ in [this repo](http - [Todo](#todo) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) + - [Want to read our code?](#want-to-read-our-code) - [License](#license) ## Security Issues @@ -307,6 +308,18 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md) +### Want to read our code? + +Some places to get you started. (WIP) + +Main file: [cmd/ipfs/main.go](https://github.com/ipfs/go-ipfs/blob/master/cmd/ipfs/main.go)
+CLI Commands: [core/commands/](https://github.com/ipfs/go-ipfs/tree/master/core/commands)
+Bitswap (the data trading engine): [exchange/bitswap/](https://github.com/ipfs/go-ipfs/tree/master/exchange/bitswap) + +DHT: https://github.com/libp2p/go-libp2p-kad-dht
+PubSub: https://github.com/libp2p/go-floodsub
+libp2p: https://github.com/libp2p/go-libp2p + ## License MIT