More and better examples

[igaray]

The README should include more runnable commands and code snippets on how to use cairo_native, to help onboarding and users understand what is capable with the library.

[estheroche]

I can take this, can you kindly assign to me? thank you

[igaray]

Done! feel free to ask questions here or in telegram at https://t.me/LambdaStarkNet

[estheroche]

thank you

[NueloSE]

@igaray can I work on this

[RJMadrigal]

@igaray i would like to take this :)

[PhantomOz]

@igaray can I work on this?

[nemealfaro]

Hi @igaray my name is Némesis Alfaro, I'm a System Engineer focused on frontend, database and IT business administrator I would like to take this task because I would like to research the topic and gain more knowledge, to provide you with more examples and details to improve your understanding of this topic.

[od-hunter]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Great! Can I be assigned this please. I’m a full stack developer and a documentarian. Below are some of the documentations I've done that were merged:

https://github.com/keep-starknet-strange/joyboy/pull/143#event-13034455918,

https://github.com/horuslabsio/Starknet-Scaffold/pull/94#event-13007360671. Some of my documentations outside GitHub:

https://t.co/ZgK0ccPZpw,

https://t.co/GnBqVQPECz.

How I plan on tackling this issue

In other to come up with a better README for this repo I’ll:

1. Add Installation Instructions: Include detailed steps for cloning the repository and installing dependencies.
2. Provide Basic Usage Examples: Show how to compile and run a simple Cairo program with specific commands.
3. Include Test Commands: Explain how to run tests to verify the installation.
4. Offer Code Snippets: Present sample Cairo code snippets with corresponding runnable commands.
5. Link to Advanced Examples: Direct users to more complex examples within the repository for deeper learning.

By following these steps, the README will be more user-friendly and help onboard new users more effectively. Here is my OnlyDust profile: https://app.onlydust.com/u/od-hunter. I will raise a PR within #-5 days unfailingly. Please assign me thank you.

[Ternder001]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

My recent work with Ethereum-Solidity and Starknet-Cairo has significantly deepened my understanding of web3 technologies, positioning me well to contribute to innovative projects in the blockchain space. As an alumnus of Web3Bridge, where I received training in Solidity and Cairo, I have developed a solid foundation in these technologies. I am eager to contribute to open-source projects within the Starknet ecosystem, and I am particularly excited about the opportunity to make meaningful contributions to this project. Given the chance, I am committed to delivering my best work and leveraging my skills to drive success.

How I plan on tackling this issue

I will approach this problem by creating a comprehensive README for Cairo Native that includes runnable commands and code snippets, follow these steps:

1. Introduction Provide a brief introduction to Cairo Native, highlighting its purpose and key features.
2. Installation Include clear instructions on how to install Cairo Native.
3. Basic Usage Demonstrate basic usage with simple examples.
4. Advanced Features Showcase advanced features with more complex examples.
5. Integration Examples Provide examples of how to integrate Cairo Native with other tools and sequencer implementations.
6. Contribution Guidelines Outline how users can contribute to the project.
7. Support and Resources List available support channels and additional resources.

[gconnect]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a software developer with over 5 Yeats of experience building both web and mobile applications and dapps and writing technical documentations with special interest in tutorial documentation. My tutorial content helps make the user/developer onboarding process into a tech or platform much easier. User onboarding and experience is something dear to my heart so I try to build applications and write content that makes the process easier.

How I plan on tackling this issue

My Approach would be to first of all study the current state of the documentation. Understand how the cairo_native library works and build a real world application to show the use case of the library. Ensure the sample application works as expected and then write a tutorial on how it was built using the library.

With this users can clearly see what is possible with the library and make the process of using the application much easier.

[knownothing10]

Can I start working on this?

[chiscookeke11]

Could I try solving this?

[2100031988]

Could I start working on this? My aim is to make it more detailed and easier to understand for everyone by incorporating various fonts and, if possible, adding videos for better clarity and engagement.

[emarc99]

I’d love to work on this task.

[Supa-mega]

Can I be assigned to this? first time contributor

[Mashtic]

Hello @igaray, my name is Fabian, and I’d love to help with this. After reading the documentation in the README, I’d suggest adding clear examples of common use cases for the cairo_native library. Additionally, I’d include a section addressing common errors users may encounter, provide clearer instructions for testing, and make some minor improvements to make it easier to understand. I believe these changes will make the cairo_native library more accessible to new users. Looking forward to your feedback!