Update README.md

This commit is contained in:
John M. Jones 2017-11-02 05:52:19 -05:00 committed by GitHub
parent 77dc2f1472
commit eeabd85bc3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,24 +1,24 @@
# C-IPFS
IPFS implementation in C, (not just an API client library).<br/>
<br/>
## Quick start for users:<br/>
IPFS implementation in C, (not just an API client library).
## Quick start for users:
* **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>
* **ipfs cat [hash]** to retrieve a file from the repository
## For techies:
getting started: https://github.com/ipfs/specs/blob/master/overviews/implement-ipfs.md
specifications: https://github.com/ipfs/specs
getting started: https://github.com/ipfs/community/issues/177
libp2p: https://github.com/libp2p/specs
## Prerequisites: To compile the C version you will need:
lmdb https://github.com/jmjatlanta/lmdb
c-protobuf https://github.com/Agorise/c-protobuf
c-multihash https://github.com/Agorise/c-multihash
c-multiaddr https://github.com/Agorise/c-multiaddr
c-libp2p https://github.com/Agorise/c-libp2p
And of course this project at https://github.com/Agorise/c-ipfs
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".