Skip to content

Commit a8ce54d

Browse files
committed
Readme update and mac installer update
1 parent 2b473c6 commit a8ce54d

File tree

2 files changed

+14
-522
lines changed

2 files changed

+14
-522
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,26 @@ Also see companion plugin, the [SmartGuitarPedal](https://github.com/GuitarML/Sm
2424

2525
## Installing the plugin
2626

27-
1. Download plugin (Windows 10, Mac, Ubuntu Linux) [here](https://github.com/keyth72/SmartGuitarAmp/releases)
28-
2. Copy to your DAW's VST directory (for Mac, use .dmg installer or copy AU/VST3 to desired folder)
27+
1. Download the appropriate plugin installer (Windows, Mac, Linux)
28+
2. Run the installer and follow the instructions. May need to reboot to allow your DAW to recognize the new plugin.
2929

3030
## Build Instructions
3131

32-
1. Clone or download this repository.
33-
2. Download and install [JUCE](https://juce.com/) This project uses the "Projucer" application from the JUCE website.
34-
3. Download [Eigen](http://eigen.tuxfamily.org)
35-
Extract Eigen to a convenient location on your system (will be linked with Projucer)
36-
4. Open SmartGuitarPedal.jucer file with Projucer
37-
5. Add the <full_path_to>/ Eigen folder to "Header Search Paths" in Exporters -> Debug/Release
38-
6. Open and build project in Visual Studio (Windows), Xcode (Mac), or Code::Blocks/Makefile (Linux)
32+
### Build with Cmake
3933

40-
Note: Make sure to build in Release mode unless actually debugging. Debug mode will not keep up with real time playing.
34+
```bash
35+
# Clone the repository
36+
$ git clone https://github.com/GuitarML/SmartGuitarAmp.git
37+
$ cd SmartGuitarAmp
4138

42-
## Using your own custom trained models (or models from the TonePack)
39+
# initialize and set up submodules
40+
$ git submodule update --init --recursive
4341

44-
Use the "Load Tone" button in the plugin to load tone models trained with PedalNetRT. The current channel's
45-
EQ/gain will be applied to the custom tone. Switching the clean/lead channel unloads the custom tone and
46-
reloads the channel's default tone.
42+
# build with CMake
43+
$ cmake -Bbuild
44+
$ cmake --build build --config Release
45+
```
46+
The binaries will be located in `SmartAmp/build/SmartAmp_artefacts/`
4747

4848
## License
4949
This project is licensed under the Apache License, Version 2.0 - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)