doc/mnt: update README with proper cloning instructions + banner (#125)

.github/workflows/build.yml

@@ -1,12 +1,6 @@
 name: build
 
 on:
- workflow_dispatch: # allows manual triggering
- inputs:
- create_release:
- description: 'Create new release'
- required: true
- type: boolean
  push:
  branches:
  - main
@@ -28,7 +22,9 @@ jobs:
  steps:
  - name: Clone
  id: checkout
- uses: actions/checkout@v1
+ uses: actions/checkout@v4
+ with:
+ submodules: true
 
  - name: Dependencies
  id: depends
@@ -44,19 +40,15 @@ jobs:
  cmake ..
  cmake --build . --config Release
 
- - name: Test
- id: cmake_test
- run: |
- cd build
- ctest --verbose --timeout 900
-
  macOS-latest-cmake:
  runs-on: macos-latest
 
  steps:
  - name: Clone
  id: checkout
- uses: actions/checkout@v1
+ uses: actions/checkout@v4
+ with:
+ submodules: true
 
  - name: Dependencies
  id: depends
@@ -70,11 +62,5 @@ jobs:
  sysctl -a
  mkdir build
  cd build
- cmake -DBARK_AVX2=OFF -DBARK_FMA=OFF ..
+ cmake ..
  cmake --build . --config Release
-
- - name: Test
- id: cmake_test
- run: |
- cd build
- ctest --verbose --timeout 900

README.md

@@ -1,6 +1,6 @@
 # bark.cpp
 
-![bark.cpp](./assets/banner.jpeg)
+![bark.cpp](./assets/banner.png)
 
 [![Actions Status](https://github.com/PABannier/bark.cpp/actions/workflows/build.yml/badge.svg)](https://github.com/PABannier/bark.cpp/actions)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
@@ -156,7 +156,7 @@ Here are the steps for the bark model.
 ### Get the code
 
 ```bash
-git clone https://github.com/PABannier/bark.cpp.git
+git clone --recursive https://github.com/PABannier/bark.cpp.git
 cd bark.cpp
 ```