Skip to content

Commit de13e06

Browse files
authored
Add example links to README (#99)
* Add example links to README * Add link to contributing
1 parent 9990083 commit de13e06

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing to Recho
2+
3+
## Sharing Examples

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- [Editor](https://recho.dev/) 📝 - The quickest way to get started with Recho.
88
- [Documentation](https://recho.dev/docs/introduction) 📚 - Learn how to use Recho with our comprehensive guides.
99
- [Examples](https://recho.dev/examples) 🖼️ - See what you can create and draw some inspiration!
10+
- [Sharing](/CONTRIBUTING.md#contributing-to-recho) 🎨 - Follow the instructions to open a [pull request](https://github.com/recho-dev/recho/new/main/app/examples) to share your sketches!
1011
- [Contributing](https://github.com/recho-dev/recho/issues) 🙏 - We have a bunch of things that we would like you to help us build together!
1112

1213
## Why Recho 💡
@@ -24,9 +25,9 @@ Ideally, you can be creative afterwards. You may find the minimalism of ASCII/te
2425

2526
Recho is still in its early stage. There are a lot of areas we want to explore and build with the community. Especially, we are interested in the following things:
2627

27-
- **More Examples** - Examples attract users and shape tools. We would love to have examples in different areas (text analysis, data viz, graphics, concrete poetry, algorithms, etc.) and working with external libraries ([D3](https://d3js.org/), [Lodash](https://lodash.com/), [ml5](https://ml5js.org/), [Tone](https://tonejs.github.io/), etc.). They don't have to be complicated or perfect. One thing to share is enough. Open a [pull request](https://github.com/recho-dev/recho/new/main/app/examples) to share yours today!
28+
- **More Examples** - Examples attract users and shape tools. We would love to have examples in different areas ([text analysis](https://recho.dev/examples/word-count), [data viz](https://recho.dev/examples/phases-of-the-moon), [graphics](https://recho.dev/examples/cg-text-based-shaders), [concrete poetry](https://recho.dev/examples/fire!), [algorithms](https://recho.dev/examples/maze), etc.) and working with external libraries ([D3](https://d3js.org/), [Lodash](https://lodash.com/), [ml5](https://ml5js.org/), [Tone](https://tonejs.github.io/), etc.). They don't have to be complicated or perfect. One thing to share would be great. Follow the [instructions](/CONTRIBUTING.md#sharing-examples) to open a [pull request](https://github.com/recho-dev/recho/new/main/app/examples) to share yours today!
2829
- **Text Based Libraries** - Best practices deserve to be seen by more people. If you find some algorithms you are using helpful for others, don't hesitate to package them into libraries. Remember, they can be light!
29-
- **Diverse Programming Languages** - Recho begins with JavaScript, but isn't limited to it—coding has no boundaries. As long as a programming language can be transpiled to JavaScript, it can be incorporated with Recho. It can be mainstream ([Python](https://www.python.org/), [Rust](https://www.rust-lang.org/)), academic ([mlscript](https://github.com/hkust-taco/mlscript)), or creative ([wenyan‑lang](https://wy-lang.org/)). The best part is that it doesn't have to be production-ready or have real-life usage. Just providing a new way to code or think is cool. Want to add your favorite language to Recho or share your "toys"? Talk to us!
30+
- **Diverse Programming Languages** - Recho begins with JavaScript, but isn't limited to it—coding has no boundaries. As long as a programming language can be transpiled to JavaScript, it can be incorporated with Recho. It can be mainstream ([Python](https://www.python.org/), [Rust](https://www.rust-lang.org/)), academic ([MLscript](https://github.com/hkust-taco/mlscript)), or creative ([wenyan‑lang](https://wy-lang.org/)). The best part is that it doesn't have to be production-ready or have real-life usage. Just providing a new way to code or think is cool. Want to add your favorite language to Recho or share your "toys"? [Talk to us](https://github.com/recho-dev/recho/discussions)!
3031
- **Interactions with LLMs** - Recho’s text-first approach is ideal for LLMs. Rather than letting the LLM write code directly, you can use code as input: fusing files, turning text into pixel outputs, and more. We want to exploring the possibilities.
3132

3233
Of course, there are a lot of editor related features on the way!

0 commit comments

Comments
 (0)