Skip to content

Commit 3730194

Browse files
committed
Updated readme to follow suit
1 parent b1738ea commit 3730194

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,23 @@ This is an audio module built on top of FastAI to allow you to quickly and easil
99
[Google Colab Notebook](https://colab.research.google.com/drive/1HUVI1CZ-CThHUBO8l2lp6hySjrbs0SY-)
1010

1111
# Installation
12-
To install, run the following commands in a shell.
12+
13+
You install the library with pip but it is recommended to clone the repo if you are new to audio so that you can follow one of the notebooks.
14+
15+
1. Git Clone
1316

1417
```
1518
git clone https://github.com/mogwai/fastai_audio
1619
cd fastai_audio
17-
sudo chmod +x install.sh
18-
./install.sh
20+
pip install -e .
21+
jupyter notebook
1922
```
2023

21-
If you wish to work in a folder other than fastai_audio, you can link the audio folder by navigating in the terminal to the folder where your notebooks are and running
22-
`ln -s /path-to-fastai-audio/audio .`
24+
2. Pip
2325

24-
This will create a symbolic link to the audio folder which contains our code. It will appear as a folder called 'audio' in your directory and you'll be able to access it using `from audio import *`, but it won't take up any additional space. To remove, just navigate to the folder where you created the symlink and type `unlink audio`. This will remove the linked folder but leave the original intact.
26+
```
27+
pip install git+https://github.com/mogwai/fastai_audio@0.1
28+
```
2529

2630
# Tests
2731

0 commit comments

Comments
 (0)