Skip to content

Commit

Permalink
colors and layout
Browse files Browse the repository at this point in the history
  • Loading branch information
jonwaterschoot committed Jan 27, 2024
1 parent ac04568 commit 8b7d97d
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 73 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ tldr;

To get up and running you need to understand the basic workflow for getting your Patches from Plugdata compiled onto the Daisy seed microcontroler.

{: .note }
> In short:
> 1. Make a compatible Plugdata patch
> 2. Setup a custom json file that describes to which pins our components are connected
> 2. Use the compile menu to upload to Daisy.
- Heavy does the translating.

{: .highlight }
> 💡 Not all existing patches work as is; they get converted; Many of the fancy visual stuff is useless for Daisy, many patches rely on stuff that isn’t supported, and Daisy also has limited CPU power compared to a computer.
- Patches get converted from pure data to C/C++ code
Expand All @@ -36,7 +38,7 @@ However Plugdata has a few advantages over doing this manually via pd2dsy:
- Installing the needed toolchain is done for you when opening the compile window
- when using Plugdata in "compile" mode you get instant feedback when something is not compatible by and autocomplete won't show unsupported objects.

{: .note }
{: .highlight }
> **Using compile mode in Plugdata**, you'll instantly see when you use incompatible objects.
> - limitting the auto-complete to hvcc compatible objects;
> - and giving warnings when you use in-compatible ones
Expand Down Expand Up @@ -68,9 +70,11 @@ In the compile window we'll point to a custom json file where we list our hardwa
![compile window custom board](img\compile_custom_json.png)
<sub>Note that there are a few other settings that aren't discussed here yet, like 'Patch size' or memory allocations, when starting leave them at the defaults, more info will be shown in the full examples.</sub>

>In the next chapter there's a full example and more elaborate info on setting up this json file.
{: .note }
> In the next chapter there's a full example and more elaborate info on setting up this json file.
For now, here's a small example of the content of the json file that's linked to our example `r my_custom_knob @hv.param`
For now, here's a small example of the content of the json file that's linked to our example
> `r my_custom_knob @hv.param`
```json
"components": {
Expand All @@ -79,18 +83,19 @@ For now, here's a small example of the content of the json file that's linked to
"pin": 21
}
}
```
```

## About the toolchain and compiling

The toolchain is a collection of needed stuff to 'export' your patches into other formats, this could be straight to C++ or in our case it provides everything we need to compile it onto the Daisy seed.

Follow [this link](https://wasted-audio.github.io/hvcc/) to learn more about Heavy

***

{: .warning }
> Note the following section is a blunt copy taken from Plugdata's documentation and was copied from Github on 26/01/2024
***
***
***

# Compilation and Integration with HVCC Compiler
Expand Down
61 changes: 14 additions & 47 deletions 01_install_setup_plugdata/03_custom_json_board/custom_json_board.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,73 +6,40 @@ nav_order: 99
# Setting up a custom json file to describe your daisy pin setup

callouts:
note:
color: grey-dk
attention:
color: grey-lt
highlight:
color: yellow
important:
title: Important
color: blue
new:
title: New
color: green
note:
title: Note
color: purple
warning:
title: Warning
color: red
new:
color: green

{: .block-lt }
This is the lite block
{: .note }
A paragraph is a note

{: .block-dk }
This is the dark block
{: .attention }
A paragraph is a note

{: .highlight }
A paragraph is highlight
A paragraph is highlighted

{: .important }
A paragraph
{: .warning }
A paragraph is important

{: .new }
A paragraph is new

{: .note }
A paragraph is note

{: .warning }
A paragraph is warning



{: .note-title }
> My note title is NOTE
>
> A paragraph with a custom title callout
{: .important }
> A paragraph
>
> Another paragraph
>
> The last paragraph
{: .important-title }
> My important title
>
> A paragraph
>
> Another paragraph
>
> The last paragraph
> {: .new }
> > A paragraph
> >
> > Another paragraph
> >
> > The last paragraph
{: .important }
{: .note }
> {: .opaque }
> <div markdown="block">
> {: .warning }
Expand Down
51 changes: 31 additions & 20 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,42 @@ color_scheme: dark

callouts_level: quiet # or loud
callouts:
note:
color: grey-dk
attention:
color: grey-lt
highlight:
color: yellow
important:
title: Important
color: grey-dk
new:
title: New
color: green
note:
title: Note
color: grey-lt
warning:
title: Warning
color: red
block-lt:
title: Did you know
color: grey-lt
block-dk:
title: Did you know
color: grey-dk



new:
color: green

kramdown:
syntax_highlighter_opts:
block:
line_numbers: true
line_numbers: false

# Footer content
# appears at the bottom of every page's main content

# Back to top link
back_to_top: true
back_to_top_text: "Back to top"

footer_content: "This site was made by jonwtr based on documentation and other guides found at various sources, Electrosmith forum, Daisy Discord, Plugdata website, Plugdata Discord, ..."

# Footer last edited timestamp
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html



# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub"
gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo
gh_edit_branch: "main" # the branch that your docs is served from
# gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

0 comments on commit 8b7d97d

Please sign in to comment.