Skip to content

Commit

Permalink
Create readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TodePond authored Jan 31, 2025
1 parent 91bb679 commit 02a211c
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# nudel docs

this is the beginning of an attempt to write some docs for nudel

maybe i'll start by at least outline the special nudel functions

## nudel library

all of the editors in nudel have access to the nudel library. the nudel library contains some helpful things that might help you get around some of nudel's restrictions (eg: no pasting).

### `hubda`

A quicker way of importing samples from a github repo.

```js
hubda('eddyflux/crate')

$: s("bd sd")
.bank("crate")
```

```js
hubda('eddyflux/wax')

$: s("atmosphere")
```

(replace `eddyflux` and `crate` with the repo owner and name)


### `speechda`

A quicker way of generating text-to-speech using shabda.

```js
speechda('hello world')

$: s("hello world")
```

you can specify what kind of voice to use. all of these lines do the same thing.

```js
speechda('fr-FR/m:hello world')
speechda("hello world", "fr-FR", "m")
speechda("hello world", "fr-FR/m")
```

todo: the other stuff

0 comments on commit 02a211c

Please sign in to comment.