Skip to content
This repository was archived by the owner on Jan 2, 2023. It is now read-only.

Commit c6999cd

Browse files
committed
update readme to include the v2&v3
1 parent e5b9bc6 commit c6999cd

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

README.MD

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,23 @@
1-
# example birdcache usage (v01)
1+
# example birdcache usage (v2&v3)
2+
3+
## requirements
4+
5+
- you need an api key.
6+
- you need python3 installed and very simple terminal usage.
7+
8+
## how to run
9+
10+
1. clone this repository `git clone https://github.com/aflorithmic/birdcache_examples`
11+
2. get into the folder `cd birdcache_examples`
12+
3. create a virtual env `python3 -m venv venv`
13+
4. activate the virtual env `source venv/bin/activate`
14+
5. install the python dependencies `pip3 install -r requirements.txt`
15+
6. open `birdcache.py` file and put your api key and your voice name
16+
7. run the code `python3 birdcache_v3.py`
17+
8. you may edit the text and personalisation parameters in the file at top.
18+
9. the next time you run the code for the same sentences, they will be cached and retrieved immediately
19+
20+
# example birdcache usage (v1)
221

322
## requirements
423

@@ -13,6 +32,6 @@
1332
4. activate the virtual env `source venv/bin/activate`
1433
5. install the python dependencies `pip3 install -r requirements.txt`
1534
6. open `birdcache.py` file and put your api key and your voice name
16-
7. run the code `python3 birdcache.py`
35+
7. run the code `python3 birdcache_v1.py`
1736
8. you may edit the sentences in `sentences.txt` file
1837
9. the next time you run the code for the same sentences, they will be cached and retrieved immediately

sentences.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
I should have known
22
I would leave alone
33
Just goes to show
4-
That the blood you bleed is justtheblood you owe
5-
Wewere a pair
6-
But I saw youthere
4+
That the blood you bleed is just the blood you owe
5+
We were a pair
6+
But I saw you there
77
Too much to bear
88
You were my life, but life is far away from fair
99
Was I stupid to love you?

0 commit comments

Comments
 (0)