diff --git a/README.md b/README.md index 1b7bfe9..b5e9d35 100644 --- a/README.md +++ b/README.md @@ -3,37 +3,39 @@ ![Screenshot](res/scrot.png) A C++ Qt graphical user interface for generating music using [acestep.cpp](https://github.com/ServeurpersoCom/acestep.cpp). -Provides endless playlist style music generation on ROCm, Vulkan or CUDA. ## Requirements - Qt 6 Core, Gui, Widgets, and Multimedia - CMake 3.14+ - acestep.cpp (bring your own binaries) -- ROCm, cuda or vulkan headers and shader compiler ## Installing -Grab the latest release from https://github.com/IMbackK/aceradio/releases/ +1. Grab the latest release from https://github.com/IMbackK/aceradio/releases/ +2. For now you will have to provide acestep.cpp binaries, these can be optained by following the instructions at https://github.com/ServeurpersoCom/acestep.cpp or the **Build acestep.cpp** section below -## Models +## Build acestep.cpp: -grab the models from [here](https://huggingface.co/Serveurperso/ACE-Step-1.5-GGUF/tree/main) +```bash +git clone https://github.com/ServeurpersoCom/acestep.cpp.git +cd acestep.cpp +mkdir build && cd build +cmake .. -DGGML_VULKAN=ON # or other backend +make -j$(nproc) +./models.sh # Download models (requires ~7.7 GB free space) +``` ## Building ### Linux / macOS - -1. clone the repo and create a build directory - * `git clone https://github.com/IMbackK/aceradio.git && cd aceradio` -2. create a build directory and enter it - * `mkdir build && cd build` -3. configure the project - * `cmake -DGGML_HIP=on ..` for ROCm support. - * `cmake -DGGML_CUDA=on ..` for CUDA support. - * `cmake -DGGML_VULKAN=on ..` for Vulkan support. -4. build the project - `make -j$(nproc)` +```bash +git clone https://github.com/IMbackK/aceradio.git +cd aceradio +mkdir build && cd build +cmake .. +make -j$(nproc) +``` ### Windows (Qt6 + CMake) @@ -60,7 +62,7 @@ Run windeployqt to copy necessary Qt libraries to the build folder: ## Setup Paths: -Go to settings->Ace Step->Model Paths and add the paths to the AceStep models. +Go to settings->Ace Step->Model Paths and add the paths to the acestep.cpp binaries the models. ## License