Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run documentation. Tutorial. Examples #291

Open
4 tasks
puria opened this issue Jul 23, 2024 · 3 comments
Open
4 tasks

Run documentation. Tutorial. Examples #291

puria opened this issue Jul 23, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@puria
Copy link
Member

puria commented Jul 23, 2024

Provide some docs to allow people to adopt more easily ncr

  • Tutorial of a service
  • Document well the metadata options. Maybe also separated by subjects
  • A set of nice and running examples
  • Refresh the --help of the CLI
@matteo-cristino matteo-cristino added the documentation Improvements or additions to documentation label Jul 30, 2024
@matteo-cristino
Copy link
Contributor

Isn't this stuff already in the README.md? 🤔

@puria
Copy link
Member Author

puria commented Jul 31, 2024

Nope ;(
Let's start one by one... I do not recall a tutorial, something is needed step by step that explains how to start using ncr and explains also the concepts with a simple usecase.

Something like this:

https://medium.com/think-do-tank/make-with-zencode-and-javascript-aka-easy-crypto-and-human-readable-smart-contracts-in-js-14067d91e8f1

To me we can use for instance this contracts:
https://github.com/ForkbombEu/tf-pqcrypto-scripts/tree/main/contracts

@matteo-cristino
Copy link
Contributor

do you want to improve the README or should we create some external documentation? For example using again vitepress

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants