c-ipfs/README.md
2017-11-02 05:50:58 -05:00

24 lines
1.2 KiB
Markdown

# C-IPFS
IPFS implementation in C, (not just an API client library).<br/>
<br/>
## Quick start for users:<br/>
* **ipfs init** to create an ipfs repository on your machine
* **ipfs add MyFile.txt** to add a file to the repository, will return with a hash that can be used to retrieve the file.
* **ipfs cat [hash]** to retrieve a file from the repository<br/>
<br/>
## For techies:<br/>
getting started: https://github.com/ipfs/specs/blob/master/overviews/implement-ipfs.md <br>
specifications: https://github.com/ipfs/specs <br>
getting started: https://github.com/ipfs/community/issues/177 <br>
libp2p: https://github.com/libp2p/specs <br>
<br>
## Prerequisites: To compile the C version you will need:<br>
lmdb https://github.com/jmjatlanta/lmdb<br>
c-protobuf https://github.com/Agorise/c-protobuf<br>
c-multihash https://github.com/Agorise/c-multihash<br>
c-multiaddr https://github.com/Agorise/c-multiaddr<br>
c-libp2p https://github.com/Agorise/c-libp2p<br>
<br>
And of course this project at https://github.com/Agorise/c-ipfs<br>
<br>
The compilation at this point is simple, but not very flexible. Place all of these projects in a directory. Compile all (the order above is recommended) by going into each one and running "make all".