Commit 1a1c5a05 authored by Jérôme Abel's avatar Jérôme Abel
Browse files

update docs

parent 18004fa6
# INSTALLATION
To use the Malinette on your computer, you have to install Pure Data (>0.48) and externals. It's not very easy, that's why we propose the [malinette-soft](https://framagit.org/malinette/malinette-soft) version. But if you want a rich experience with Pure Data, it is better to install it on your computer. Note that, since version 0.46, you can download the externals one by one from the Pure Data menu "Help > Find externals".
To use the Malinette on your computer, you have to install Pure Data (>0.51) and externals. It's not very easy, that's why we propose the [malinette-soft](https://framagit.org/malinette/malinette-soft) version. But if you want a rich experience with Pure Data, it is better to install it on your computer. Note that, since version 0.46, you can download the externals one by one from the Pure Data menu "Help > Find externals".
## Summary
- Install and run Pure Data.
......@@ -9,7 +9,7 @@ To use the Malinette on your computer, you have to install Pure Data (>0.48) and
- Give the paths of all externals and the malinette to Pd with the .pdsettings file.
## Windows
- Download and install [Pure Data.exe](http://msp.ucsd.edu/Software/pd-0.50-2.windows-installer.exe).
- Download and install [Pure Data.exe](http://msp.ucsd.edu/Software/pd-0.51-3.windows-installer.exe).
- Install Pure Data and run it. It should create a "%AppData%\Pd\externals" folder (usually C:\Users\user_name\AppData\Roaming\Pd), where we want to put Malinette files. Quit it.
- Download [malinette-soft-win-master.zip](https://framagit.org/malinette/malinette-soft/malinette-soft-win/-/archive/master/malinette-soft-win-master.zip) to get all externals and the "msvcr71.dll" file. Command to find it in tour computer : dir msvcr71.dll /s /p
- Extract malinette-soft-win-master. Move all files in "externals" to your personal "%AppData%\Pd\externals" folder.
......@@ -26,7 +26,7 @@ To use the Malinette on your computer, you have to install Pure Data (>0.48) and
- [pix_video] on Windows 10 does not work with the integrated camera. May be this version of Gem on : https://github.com/avilleret/Gem/releases or use an external usb webcam (~logitech)
## Mac OS X
- Download and install [Pure Data.tar.gz](http://msp.ucsd.edu/Software/pd-0.50-2-i386.mac.tar.gz) : 32-bit ("i386") Macintosh version for OSX 10.6 or later. We use the Gem library, so you should download the 32 bits version. Some infos on the [pd-list](https://lists.puredata.info/pipermail/pd-list/2017-09/120361.html).
- Download and install [Pure Data.tar.gz](http://msp.ucsd.edu/Software/pd-0.51-3.mac.tar.gz) : 32-bit ("i386") Macintosh version for OSX 10.6 or later. We use the Gem library, so you should download the 32 bits version. Some infos on the [pd-list](https://lists.puredata.info/pipermail/pd-list/2017-09/120361.html).
- May be you should need to install [X Quartz](http://xquartz.macosforge.org/landing) too. Not sure.
- Run Pure Data. You should pass through the "Impossible to open Pd.app" window. The common way is to right click on "Pd.app" and open it. Or you could also go to "System Preferences > Security and confidentiality" and allow "Pd.app". When Pd is opened, it should create a "~/Library/Pd/externals" folder, where we want to put Malinette files. To view this folder, clic on "Finder > Go to" with the "alt" Key...
- Download [malinette-soft-mac-master.zip](https://framagit.org/malinette/malinette-soft/malinette-soft-mac/-/archive/master/malinette-soft-mac-master.zip) to get all externals and the "msvcr71.dll" file.
......
......@@ -12,7 +12,7 @@ A Free Open Source Kit To Simplify Programming Interactivity
Special thanks for all Pure Data developers. We've taken some good ideas from few great projects (pdmtl abstractions, DIY2, rjdj, ...).
## Description
Malinette is an all-in-one solution, a rapid prototyping tool to show and make simple interaction and multimedia projects. It is a software and a hardware set. **The software is based now on Pure Data Vanilla**, previous versions was based on Pure Data Extended. It is also a very convenient suitcase and wood boxes with sensors, actuators, Arduino, Teensy and electronic components to test ideas and projects very quickly.
Malinette is an all-in-one solution, a rapid prototyping tool to show and make simple interaction and multimedia projects. It is a software and a hardware set. The software is based on Pure Data Vanilla. It is also a very convenient suitcase and wood boxes with sensors, actuators, Arduino, Teensy and electronic components to test ideas and projects very quickly.
## Architecture
The Malinette software is divided in three parts from newbies to advanced users:
......@@ -28,7 +28,7 @@ The Malinette software is divided in three parts from newbies to advanced users:
## Requirements
- Computer: a decent computer (>2008 is adviced)
- Operating system: should work on Mac OS X, MS Windows and main GNU/Linux distributions.
- Pure Data: >0.48 version
- Pure Data: >0.51 version
- Dependencies (externals): bassemu~ comport cyclone ext13 Gem ggee hcs hid (or hidin for windows) iemguts iemlib list-abs mapping maxlib moocow pix_fiducialtrack pmpd puremapping purepd sigpack tof zexy
See the "INSTALL.md" file for installation advices.
......@@ -50,12 +50,12 @@ So, for malinette-soft users, you can keep your old malinette-ide folder and pic
## Configurations
### Resize patchs
Sometimes, depends on operating system, the menu and patches does not show as you wish. After copy a backup of "malinette-ide", you can resize all patches with the "tools/resize_patches.sh" script. Edit it to find your special dimensions.
Sometimes, depends on operating system, the menu and patches don't show as you wish. After copy a backup of "malinette-ide", you can resize all patches with the "tools/resize_patches.sh" script. Edit it to find your special dimensions.
### Preferences
In the "preferences/preferences.txt" file you can change the lang of the interface, the port of an Arduino, the screen size of video rendering. We added extra features like EDIT to not allow edit mode on the menu, and 10BITS to allow 10 bits sensor for BrutBox Midi interface.
Another setup could be to change the list of objects, it is possible by editing the "preferences/malinette-objects-list.txt" or change the line "malinette-objects:".
Another setup could be to change the list of objects, it is possible by editing the "preferences/malinette-objects-list.txt".
## User instructions
- Open the "MALINETTE.pd" for the standard version or the "BRUTBOX.pd" for the Brutbox version.
......@@ -70,9 +70,9 @@ To start a project, first way is to open the "new" patch, fill it with some obje
## Content
- ./abs : all objects (audio, in, numbers, out, seq, video)
- ./docs : some documentations (license, todo, changes) and all objects in a html file
- ./docs : images for documentation (see [malinette-docs](https://framagit.org/malinette/malinette-docs) for objects and exemples documentations)
- ./examples : examples and manual patches, also some processing examples
- ./preferences : preferences file, language translations, logos and all dependencies
- ./preferences : preferences file, language translations, logos and dependencies
- ./projects : your projects folders
- ./tools : scripts to make helps, download packages, tclplugins, ..
- MALINETTE.pd : open this patch to start the ide
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment