More explanations and text wrapping
This commit is contained in:
parent
b43b130553
commit
d0f31e5745
39
index.md
39
index.md
@ -16,14 +16,37 @@ An implementation of the prole2prole protocol in Python.
|
||||
|
||||
### Join In
|
||||
|
||||
Feel most welcome to join! [Come and say hello](#get-in-touch)!
|
||||
Feel most welcome to join! Hyperpy is a non-commercial volunteer-run project
|
||||
which currently receives no funding. We hope the funding situation will change
|
||||
but right now, we're doing it because we think it is important and try to make
|
||||
time for it alongside the rest of \$life. With that said, please do [come and
|
||||
say hello](#get-in-touch)!
|
||||
|
||||
Right now, we need help implementing the remaining modules that make up the dependency graph of Hypercore. That does involve some pretty gnarly Python programming. Some modules are easier than others, so its good to pick something that interests you. In general, the process of implementing a module looks like this.
|
||||
The two main needs we have right now are are 1. applying for grant funding 2.
|
||||
python programming.
|
||||
|
||||
1. Look at [this graph](https://datcxx.github.io/hypercore.svg) of the Hypercore dependency graph and pick a module that is not already implemented and seems interesting to you.
|
||||
1. Try to understand the high-level of what module is trying to achieve. Then, read the Javascript. If you need help from the implementors of that module, you can most likely find them hanging out in [the Hypercore protocol Discord server](https://discord.com/invite/ga5hxGf), they are a friendly bunch.
|
||||
1. Before starting, you'll need to investigate if the ways of doing things in the Javascript module can be translated to Python. For example, how NodeJS streams work will not easily translate to the way we use streams in Python. It is good to have an idea of what will need to be changed / created / adapted to before diving into the implementation.
|
||||
1. Finally, go ahead and implement the module! If you like, you can use [this Python package cookiecutter](https://git.autonomic.zone/decentral1se/pypkgtemplate) to get started quick and use the same configuration as the other modules.
|
||||
Regarding the programmming, we need help implementing the remaining modules
|
||||
that make up the dependency graph of Hypercore. That does involve some pretty
|
||||
gnarly Python programming. Some modules are easier than others, so its good to
|
||||
pick something that interests you. In general, the process of implementing a
|
||||
module looks like this.
|
||||
|
||||
1. Look at [this graph](https://datcxx.github.io/hypercore.svg) of the
|
||||
Hypercore dependency graph and pick a module that is not already implemented
|
||||
and seems interesting to you.
|
||||
1. Try to understand the high-level of what module is trying to achieve. Then,
|
||||
read the Javascript. If you need help from the implementors of that module,
|
||||
you can most likely find them hanging out in [the Hypercore protocol Discord
|
||||
server](https://discord.com/invite/ga5hxGf), they are a friendly bunch.
|
||||
1. Before starting, you'll need to investigate if the ways of doing things in
|
||||
the Javascript module can be translated to Python. For example, how NodeJS
|
||||
streams work will not easily translate to the way we use streams in Python.
|
||||
It is good to have an idea of what will need to be changed / created /
|
||||
adapted to before diving into the implementation.
|
||||
1. Finally, go ahead and implement the module! If you like, you can use [this
|
||||
Python package
|
||||
cookiecutter](https://git.autonomic.zone/decentral1se/pypkgtemplate) to get
|
||||
started quick and use the same configuration as the other modules.
|
||||
|
||||
### Get in Touch
|
||||
|
||||
@ -35,5 +58,5 @@ We're lurking in a few places...
|
||||
|
||||
### Other Implementations
|
||||
|
||||
- [datrs](https://github.com/datrs/)
|
||||
- [datcxx](https://datcxx.github.io/)
|
||||
- [Datrs](https://github.com/datrs/)
|
||||
- [Datcxx](https://datcxx.github.io/)
|
||||
|
Loading…
x
Reference in New Issue
Block a user