Skip to content

Commit 7ed5545

Browse files
authored
Update package.json meta fields (#174)
1 parent 87fb437 commit 7ed5545

File tree

7 files changed

+43
-18
lines changed

7 files changed

+43
-18
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Recho Notebook - Contributing
22

3-
Recho Notebook is open source and released under the [ISC license](/LICENCE). You are welcome to contribute in different ways: open a [pull request](https://github.com/recho-dev/recho/pulls), participate in [issues](https://github.com/recho-dev/recho/issues) and [discussions](https://github.com/recho-dev/recho/discussions) or star this project!
3+
Recho Notebook is open source and released under the [ISC license](/LICENCE). You are welcome to contribute in different ways: open a [pull request](https://github.com/recho-dev/notebook/pulls), participate in [issues](https://github.com/recho-dev/notebook/issues) and [discussions](https://github.com/recho-dev/notebook/discussions) or star this project!
44

55
## Sharing Examples
66

77
All the examples are located in `app/examples`. The quickest way to add an example is through GitHub's web editor:
88

9-
- Go to [new file](https://github.com/recho-dev/recho/new/main/app/examples).
9+
- Go to [new file](https://github.com/recho-dev/notebook/new/main/app/examples).
1010
- Enter the filename in the format of `[NOTEBOOK-NAME].recho.js`.
1111
- Add the metadata as doc strings at the top of the file.
1212
- Add the code below the metadata.
@@ -39,7 +39,7 @@ Here is an example:
3939
echo("Hello World");
4040
```
4141

42-
This is a [pull request](https://github.com/recho-dev/recho/pull/82) you can refer to.
42+
This is a [pull request](https://github.com/recho-dev/notebook/pull/82) you can refer to.
4343

4444
If you prefer a `snapshot thumbnail`, create an image file named `[NOTEBOOK-NAME].snap.[FORMAT]` in `app/examples`, such as [sin-wave-radios.snap.png](./app/examples/sin-wave-radios.snap.png) for [sin-wave-radios.recho.js](/app/examples/sin-wave-radios.recho.js).
4545

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
- [Announcement](https://medium.com/@subairui/a-lighter-way-to-code-with-creativity-8c0ac739aa6f) 📢 - Read our initial release story to discovery the vision behind Recho Notebook.
1111
- [Documentation](https://recho.dev/notebook/docs/introduction) 📚 - Learn how to use Recho Notebook with our comprehensive guides.
1212
- [Examples](https://recho.dev/notebook/examples) 🖼️ - See what you can create and draw some inspiration!
13-
- [Sharing](/CONTRIBUTING.md#sharing-examples) 🎨 - Follow the instructions to open a [pull request](https://github.com/recho-dev/recho/new/main/app/examples) to share your sketches!
14-
- [Contributing](/CONTRIBUTING.md) 🙏 - We have [a bunch of things](https://github.com/recho-dev/recho/issues) that we would like you to help us build together!
13+
- [Sharing](/CONTRIBUTING.md#sharing-examples) 🎨 - Follow the instructions to open a [pull request](https://github.com/recho-dev/notebook/new/main/app/examples) to share your sketches!
14+
- [Contributing](/CONTRIBUTING.md) 🙏 - We have [a bunch of things](https://github.com/recho-dev/notebook/issues) that we would like you to help us build together!
1515

1616
## Why Recho Notebook 💡
1717

@@ -32,18 +32,18 @@ By "creativity", we mean you can end up doing something fun, and find a new way
3232

3333
Recho Notebook is still in its early stage. While there's still much work to do, we're excited to release the beta version and make it open source right now. If you're interested in trying it out, please visit the [website](https://recho.dev/notebook). Since the source code is available at GitHub here, we welcome any thoughts, comments, or suggestions. If you're interested in contributing to Recho Notebook, we're especially interested in these areas:
3434

35-
- **More Examples** - Examples attract users and shape tools. We would love to showcase examples across diverse areas ([text analysis](https://recho.dev/notebook/examples/word-count), [data viz](https://recho.dev/notebook/examples/phases-of-the-moon), [graphics](https://recho.dev/notebook/examples/cg-text-based-shaders), [concrete poetry](https://recho.dev/notebook/examples/fire!), [algorithms](https://recho.dev/notebook/examples/maze), etc.) and demonstrations 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!
36-
- **Polyglot Programming** - Recho Notebook 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 Notebook. 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 different way to code or think is cool. Want to add your favorite language to Recho Notebook or share your "toys"? [Talk to us](https://github.com/recho-dev/recho/issues/109)!
35+
- **More Examples** - Examples attract users and shape tools. We would love to showcase examples across diverse areas ([text analysis](https://recho.dev/notebook/examples/word-count), [data viz](https://recho.dev/notebook/examples/phases-of-the-moon), [graphics](https://recho.dev/notebook/examples/cg-text-based-shaders), [concrete poetry](https://recho.dev/notebook/examples/fire!), [algorithms](https://recho.dev/notebook/examples/maze), etc.) and demonstrations 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/notebook/new/main/app/examples) to share yours today!
36+
- **Polyglot Programming** - Recho Notebook 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 Notebook. 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 different way to code or think is cool. Want to add your favorite language to Recho Notebook or share your "toys"? [Talk to us](https://github.com/recho-dev/notebook/issues/109)!
3737
- **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!
38-
- **Explorations with LLMs** - Recho Notebook'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 [explore the possibilities](https://github.com/recho-dev/recho/issues/110).
38+
- **Explorations with LLMs** - Recho Notebook'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 [explore the possibilities](https://github.com/recho-dev/notebook/issues/110).
3939

4040
In addition to these, there are a lot of editor related features on the way!
4141

42-
- **Editing Optimization** - Improve editing experiences. ([rerunning blocks](https://github.com/recho-dev/recho/issues/42), [formatting code](https://github.com/recho-dev/recho/issues/108), etc.)
43-
- **Visual Enhancement** - More expressive and informative editor. ([dark theme](https://github.com/recho-dev/recho/issues/104), [ANSI escape codes](https://github.com/recho-dev/recho/issues/45), etc.)
44-
- **Interactivity** - Response to user inputs. ([mouse](https://github.com/recho-dev/recho/issues/34), [keyboard](https://github.com/recho-dev/recho/issues/105), etc.)
42+
- **Editing Optimization** - Improve editing experiences. ([rerunning blocks](https://github.com/recho-dev/notebook/issues/42), [formatting code](https://github.com/recho-dev/notebook/issues/108), etc.)
43+
- **Visual Enhancement** - More expressive and informative editor. ([dark theme](https://github.com/recho-dev/notebook/issues/104), [ANSI escape codes](https://github.com/recho-dev/notebook/issues/45), etc.)
44+
- **Interactivity** - Response to user inputs. ([mouse](https://github.com/recho-dev/notebook/issues/34), [keyboard](https://github.com/recho-dev/notebook/issues/105), etc.)
4545

46-
Also, we have plans to provide [cloud storage services](https://github.com/recho-dev/recho/issues/107). But we don't want to overcomplicate things at this point, so any thoughts, comments, and suggestions are welcome!
46+
Also, we have plans to provide [cloud storage services](https://github.com/recho-dev/notebook/issues/107). But we don't want to overcomplicate things at this point, so any thoughts, comments, and suggestions are welcome!
4747

4848
## A Quick Example 🚀
4949

app/Nav.jsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export function Nav() {
2929
const confirm = window.confirm(
3030
`Make a Pull Request to share your notebook to Examples!\n- Input the filename\n- Copy the code\n- Click the "Commit changes" button`,
3131
);
32-
if (confirm) window.open("https://github.com/recho-dev/recho/new/main/app/examples", "_blank");
32+
if (confirm) window.open("https://github.com/recho-dev/notebook/new/main/app/examples", "_blank");
3333
}
3434

3535
function isSelected(path) {
@@ -131,7 +131,7 @@ export function Nav() {
131131
</SafeLink>
132132

133133
<a
134-
href="https://github.com/recho-dev/recho/new/main/app/examples"
134+
href="https://github.com/recho-dev/notebook/new/main/app/examples"
135135
onClick={handleUpload}
136136
target="_blank"
137137
rel="noreferrer"
@@ -144,7 +144,7 @@ export function Nav() {
144144
<Share className={cn(styles.linkIcon)} />
145145
</a>
146146
<a
147-
href="https://github.com/recho-dev/recho"
147+
href="https://github.com/recho-dev/notebook"
148148
target="_blank"
149149
rel="noreferrer"
150150
className={cn(styles.link)}

app/docs/introduction.recho.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ function map(x, d0, d1, r0, r1) {
149149
/**
150150
* Please visit the GitHub repository for more details:
151151
*
152-
* > https://github.com/recho-dev/recho
152+
* > https://github.com/recho-dev/notebook
153153
*
154154
* - [1] https://luyu.computer/
155155
* - [2] https://recho.dev/

app/examples/ExampleEditor.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export function ExampleEditor({example, initialCode}) {
2626
toolBarStart={
2727
<div className={cn("flex items-center")} key={example.slug}>
2828
<a
29-
href={`https://github.com/recho-dev/recho/pull/${example.pull_request}`}
29+
href={`https://github.com/recho-dev/notebook/pull/${example.pull_request}`}
3030
target="_blank"
3131
rel="noreferrer"
3232
className={cn("bg-green-700 text-white rounded-md px-3 py-1 text-sm hover:bg-green-800")}

app/examples/cg-text-based-shaders.recho.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -648,5 +648,5 @@ echo(
648648
* to use multiple spheres and lights to create more complex effects.
649649
*
650650
* I hope you have enjoyed this tutorial. If you have any questions, please
651-
* feel free to comment on https://github.com/recho-dev/recho/issues/98.
651+
* feel free to comment on https://github.com/recho-dev/notebook/issues/98.
652652
*/

package.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
11
{
2+
"name": "recho-notebook",
3+
"version": "0.1.0",
4+
"description": "A free, open-source, reactive editor for algorithms and ASCII art. It introduces a plain code format for notebooks — echoing output inline as comments for live, in-situ coding with instant feedback.",
5+
"author": "Recho",
6+
"license": "ISC",
7+
"homepage": "https://recho.dev/notebook",
8+
"repository": {
9+
"type": "git",
10+
"url": "https://github.com/recho-dev/notebook.git"
11+
},
12+
"bugs": {
13+
"url": "https://github.com/recho-dev/notebook/issues"
14+
},
15+
"keywords": [
16+
"notebook",
17+
"reactive",
18+
"editor",
19+
"javascript",
20+
"observable",
21+
"ascii-art",
22+
"algorithms",
23+
"live-coding",
24+
"creative-coding",
25+
"computational-art"
26+
],
227
"type": "module",
328
"scripts": {
429
"dev": "vite",

0 commit comments

Comments
 (0)