Skip to content

Commit

Permalink
Prepared for version 0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
00sapo committed Dec 15, 2020
1 parent d392f39 commit 183909c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
19 changes: 11 additions & 8 deletions docs/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,23 @@ Installation

The backbone of this project are the multiple dependencies on which it depends. Since it's difficult to provide a script to automatically install all of these dependencies, here is a little handbook about how to install them.

TLDR
````

#. Use Linux: it's free. For Windows and Mac, you can still install Carla and
Jack by yourself; however, I refuse to support non-free software.
#. In general, use https://pkgs.org to look for the command needed in your
distro.
#. Install: ``jackd``
#. Install: ``jackd`` 1.9
#. Make sure that it is available in your ``PATH`` environment variable

Installing pycarla
``````````````````
1. Installing pycarla
`````````````````````

``pip install --upgrade pip pycarla``

Installing jack
```````````````
2. Installing jack
``````````````````

#. Ubuntu/Debian based: ``sudo apt-get install jackd2``
#. Arch based: ``sudo pacman -Sy jack2``
Expand All @@ -26,8 +29,8 @@ Installing jack
For other Os, pre-built binaries are available at
https://jackaudio.org/downloads/

Installing Carla
``````````````````
3. Installing Carla
```````````````````

After having installed the package, run ``python -m pycarla.carla --download``
to download the correct version of Carla.
Expand Down Expand Up @@ -55,4 +58,4 @@ Used plugins are:

.. _SalamanderGrandPianoV3: http://freepats.zenvoid.org/Piano/SalamanderGrandPiano/SalamanderGrandPianoV3+20161209_48khz24bit.tar.xz

#. Run ``poetry run -m pycarla`` to do a little test
#. Run ``poetry run -m pycarla <a_midi_file.mid>`` to do a little test
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "pycarla"
version = "0.1.0"
version = "0.1.1"
description = "Use VST/LV2/etc. plugins with realtime abilities in Python"
authors = ["Federico Simonetta <[email protected]>"]
license = "GPL-3.0-only"
Expand Down

0 comments on commit 183909c

Please sign in to comment.