Create a better Readme

Question

Create a better Readme

Closed this issue 2 years ago · 2 comments

cereallarceny commented 4 years ago

Based on this readme template, we should improve our readmes across all OpenMined projects.

Please consult the following document for our desired best practices.

Answer 1 · 2022-03-25T04:23:15.000Z

Is this issue still open I would like to contribute.

Answer 2 · 2023-01-09T20:11:06.000Z

Issue is still open. We have a good readme in the Javascript subsection, but it lacks a description of the math behind the crypto that is in the comments in the C++ code.