Skip to content

Commit

Permalink
doc: Added instructions on to install, run, and build project in README
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolasperez19 authored Oct 30, 2024
1 parent 8244419 commit a8e73a9
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,31 @@ MicMasterFlex addresses this by offering an interactive, visual interface to con

Additionally, the tool generates the necessary `numpy` code for these positions, streamlining the setup process for audio processing and sound localization tasks.

## 📋 Prerequisites
In order to run the project locally, you must have [Bun runtime](https://bun.sh/) installed.

## 💾 Installation
To install the project locally, clone the git repository and install all dependencies by running the following commands in your terminal:
```sh
git clone https://github.com/nicolasperez19/mic-master-flex.git
cd mic-master-flex
bun install
```

## 🏃‍♂️💨 Running the Project Locally
To run the project locally in developer mode, run the following command in your terminal:
```sh
bun run dev
```

## 🏗️ Building the Project Locally
To build the project locall, run the following command in your terminal:
```sh
bun run build
```

The production version of the site will be available in the `./dist` folder.

## 🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:
Expand Down

0 comments on commit a8e73a9

Please sign in to comment.