Skip to content

Commit

Permalink
Link to Plugins guide in docs, and fix Meta Module => MetaModule
Browse files Browse the repository at this point in the history
[no ci]
  • Loading branch information
danngreen committed Jul 26, 2024
1 parent 7dd95ba commit 85ecac7
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 11 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Meta Module
# MetaModule

[![Build Simulator](https://github.com/4ms/metamodule/actions/workflows/build_simulator.yml/badge.svg)](https://github.com/4ms/metamodule/actions/workflows/build_simulator.yml)
[![Build VCV Rack Plugin](https://github.com/4ms/metamodule/actions/workflows/build_vcv_plugin.yml/badge.svg)](https://github.com/4ms/metamodule/actions/workflows/build_vcv_plugin.yml)
Expand Down Expand Up @@ -30,7 +30,7 @@ Next, setup your development environment by [following the instructions on this

## Next Steps

The Meta Module environment is built using three separate components: The VCV Rack Plugin (which includes the Meta Module patch exporter module), the Firmware for the Meta Module hardware, and the Firmware Simulator that allows you to run the firmware locally to test changes.
The MetaModule environment is built using three separate components: The VCV Rack Plugin (which includes the MetaModule patch exporter module), the Firmware for the MetaModule hardware, and the Firmware Simulator that allows you to run the firmware locally to test changes.

For information about building and using these components, please follow the separate guides:

Expand All @@ -40,11 +40,11 @@ For information about building and using these components, please follow the sep

## Usage

- [Creating Meta Module Patches With VCV](./docs/BasicVCVPatching.md)
- [Creating MetaModule Patches With VCV](./docs/BasicVCVPatching.md)
- [Updating Firmware](./docs/user-firmware-update.md)


## Contributing

If you would like to port your own VCV modules to the Meta Module platform, please see the [Porting Guide](./docs/Porting.md).
If you would like to create plugins of your own VCV modules for the MetaModule platform, please see the [Plugin Guide](./docs/Plugins.md).

6 changes: 4 additions & 2 deletions docs/Porting.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
### Instructions for adding a new module

For creating a plugin, see [metamodule-plugin-examples](https://github.com/4ms/metamodule-plugin-examples)
For creating a plugin, see [Plugins.md](Plugins.md)

-----

Below are instructions for adding a new built-in brand from an existing VCV Rack plugin, statically compiled
into the main firmware.
into the main firmware. This is not a common thing, typically you will use plugins (see above).

1) **Add the module code as a git submodule into vcv_ports/**

Expand Down
6 changes: 3 additions & 3 deletions docs/Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ TODO: other distros
To get started, you will want to follow the development environment guide for
VCV Rack [here](https://vcvrack.com/manual/Building#Windows). This will help
you set up an MSYS2/MinGW development environment along with most packages
required for Meta Module development. In short, install [MSYS](http://www.msys2.org/)
required for MetaModule development. In short, install [MSYS](http://www.msys2.org/)
and then open the MinGW 64-bit shell and run:

```
Expand Down Expand Up @@ -126,7 +126,7 @@ arm-none-eabi-gcc --version
You should see the version number and some copyright info. If not, check where
the arm-none-eabi package was installed and adjust your PATH setting.

*Tip*: When building anything for Meta Module, be sure to launch the MinGW 64-Bit
*Tip*: When building anything for MetaModule, be sure to launch the MinGW 64-Bit
shell! If you have Windows Terminal installed, it is worth setting up a profile
so that you can easily launch MinGW 64-Bit shells as Terminal tabs. If you have
Windows Terminal installed, you can open the Settings menu and create a
Expand All @@ -144,7 +144,7 @@ you should set the Icon option. Again, with default paths, this path is
C:/msys64/mingw64.ico
```

*Tip*: Many elements of the Meta Module code require C++23, so if you previously setup
*Tip*: Many elements of the MetaModule code require C++23, so if you previously setup
a VCV environment (or an MSYS2 environment), you might need to update `gcc` to
`gcc-12` or higher. To find out which version you are using, you need to open
up a MinGW 64-Bit shell. Type the following command:
Expand Down
4 changes: 2 additions & 2 deletions docs/firmware-loading.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,9 +183,9 @@ make flash-app-sd

This will build the application as normal, and then use `dd` to copy it to the fourth partition.

Eject the card and insert it into the Meta Module.
Eject the card and insert it into the MetaModule.

To tell the Meta Module to boot using the SD Card, you need to change the BOOT DIP switches.
To tell the MetaModule to boot using the SD Card, you need to change the BOOT DIP switches.
These are located on the back of the PCB, under the screen near the rotary encoder.
They are labeled "BOOT0_2". There are two switches. Look at the diagram printed on the PCB.
To boot with the SD, both switches should be pushed to the left.
Expand Down

0 comments on commit 85ecac7

Please sign in to comment.