From 3ac7f57b72d866f298fcb93c0feaaeb11f493b7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=96zg=C3=BCr?= Date: Mon, 30 Sep 2024 21:18:29 +0300 Subject: [PATCH] added "install dependencies" section to readme --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3f088e3c..dbaf8711 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ -# HephAudio +# HephAudio [![Static Badge](https://img.shields.io/badge/License-LGPL%20v2.1-blue)](https://github.com/ozguronsoy/HephAudio/blob/master/LICENSE.md) [![GitHub Release](https://img.shields.io/github/v/release/ozguronsoy/HephAudio)](https://github.com/ozguronsoy/HephAudio/releases/) -[![Static Badge](https://img.shields.io/badge/License-LGPL%20v2.1-blue)](https://github.com/ozguronsoy/HephAudio/blob/master/LICENSE.md) -[![GitHub Release](https://img.shields.io/github/v/release/ozguronsoy/HephAudio)](https://github.com/ozguronsoy/HephAudio/releases/) [![GitHub Pages](https://github.com/ozguronsoy/HephAudio/actions/workflows/github_pages.yml/badge.svg)](https://github.com/ozguronsoy/HephAudio/actions/workflows/github_pages.yml) [![Build Linux](https://github.com/ozguronsoy/HephAudio/actions/workflows/build_linux.yml/badge.svg)](https://github.com/ozguronsoy/HephAudio/actions/workflows/build_linux.yml) [![Build Windows](https://github.com/ozguronsoy/HephAudio/actions/workflows/build_windows.yml/badge.svg)](https://github.com/ozguronsoy/HephAudio/actions/workflows/build_windows.yml) [![Build Android](https://github.com/ozguronsoy/HephAudio/actions/workflows/build_android.yml/badge.svg)](https://github.com/ozguronsoy/HephAudio/actions/workflows/build_android.yml) - [Setup](#setup)
+ - [Install Dependencies](#install-dependencies)
- [CMake](#cmake)
- [Visual Studio](#visual-studio)
- [Getting Started](#getting-started)
@@ -30,13 +29,20 @@ HephAudio is a cross-platform audio library that provides:
## Setup +### Install Dependencies + +- Install [CMake](https://cmake.org/download/) 25.0.0 or higher.
+- Install ALSA development library for **Linux**.
+- build FFmpeg and libmysofa for **macOS** and **iOS**.
+ + ### CMake #### Create Shared/Static Library 1) Clone the repo.
2) Run one of the following commands: - - to create shared library: ``cmake -DENABLE_SHARED=On -DCMAKE_CXX_FLAGS='-DHEPHAUDIO_INFO_LOGGING' .``
- - to create static library: ``cmake -DENABLE_STATIC=On -DCMAKE_CXX_FLAGS='-DHEPHAUDIO_INFO_LOGGING' .``
+ - to create **shared** library: ``cmake -DENABLE_SHARED=On -DCMAKE_CXX_FLAGS='-DHEPHAUDIO_INFO_LOGGING' .``
+ - to create **static** library: ``cmake -DENABLE_STATIC=On -DCMAKE_CXX_FLAGS='-DHEPHAUDIO_INFO_LOGGING' .``
3) Run ``cmake --build .`` then ``cmake --install .``
4) Create a folder at your project's root and name it ``HephAudio`` (/project_root/HephAudio).
5) Copy the contents of the ``build`` folder to ``/project_root/HephAudio``.