Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@eliottparis
eliottparis committed Jun 1, 2018
1 parent f0e14da commit f0d8ba0
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 24 deletions.
4 changes: 2 additions & 2 deletions Client/Source/KiwiApp.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
namespace ProjectInfo
{
const char* const projectName = "Kiwi";
const char* const versionString = "v1.0.0";
const int versionNumber = 0x100;
const char* const versionString = "v1.0.1";
const int versionNumber = 0x101;
}

namespace kiwi
Expand Down
4 changes: 2 additions & 2 deletions docs/developper/dev.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Here is a list of tested compilers depending on your platform.

- MacOs: clang 7.3.1
- Windows: msvc 19.0
- Linus: gcc-4.9
- Linux: gcc-4.9

```shell
python ./Script/build.py
Expand Down Expand Up @@ -85,7 +85,7 @@ The api server also uses a json file for its settings. Its easier to use the sam
ex:
```json
{
"session_port": 1000,
"session_port": 1000,
"backend_directory": "server_backend",
"open_token": "etienned@o",
"kiwi_version": "v1.0.0"
Expand Down
9 changes: 4 additions & 5 deletions docs/software/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,19 @@ Kiwi is compatible with the three main operating system.

- Macos : version 10.7 and later.
- Windows : windows 7 and later.
- Linus : tested with ubuntu 14.04
- Linux : tested with ubuntu 14.04

## Installing

Once download is complete, the corresponding archive shall be extracted by double clicking on it. A Kiwi folder containing the application is then created. On macos and linux copy the application to your app folder (Application folder on Mac, /usr/bin on linux). Windows users may execute the installer.
Once download is complete, the corresponding archive shall be extracted by double clicking on it. A Kiwi folder containing the application is then created. On macOS and linux, copy the application to your app folder (Application folder on Mac, /usr/bin on linux). Windows users may execute the installer.

## Lauching Kiwi
## Launching Kiwi

When Kiwi is executed three main windows appear : The Document Browser, the Beacon Dispatcher and Kiwi's console.
When Kiwi is executed two main windows appear : The Document Browser and the Kiwi's console.

<table style="border: 0px">
<tr>
<th style="border: 0px"><img title="DocumentBrowser" src="../ressources/img/emptyDocumentBrowser.png" height=500 /></th>
<th style="border: 0px"><img src="../ressources/img/emptyBeaconDispatcher.png" height=200></th>
<th style="border: 0px"><img = src="../ressources/img/emptyKiwiConsole.png" height=400></th>
</tr>
</table>
Expand Down
30 changes: 15 additions & 15 deletions docs/software/objects.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ A list of help patches describing how each object works is <a href="../ressource
| **noise~** | | A white noise generator |
| **sah~** | | Samples and holds an input signal |
| **hub** | | Send message to other users |
| **send** | *s* | Send message to matching receive object |
| **send** | *s* | Send messages to a receiver bound to the same name |
| **mtof** | | Convert midi notes to frequencies |
| **number~** | | Display audio samples values |
| **number** | | Display a nuumber |
| **select** | | Ouput bang if receive matching input |
| **snapshot~** | | Ouput sample signal values |
| **random** | | Ouput random number in a uniform distribution |
| **unpack** | | Access elements in a list |
| **pack** | | Create and outputs a list of messages |
| **number** | | Display and output number |
| **select** | *sel* | Output bangs based on input matching |
| **snapshot~** | | Output sample signal values |
| **random** | | Generate a random number |
| **unpack** | | Breaks a list into individual atoms |
| **pack** | | Create a list from individual atoms |
| **comment** | | Add a comment to the patch |
| **!=~** | | Signal inequality operator |
| **==~** | | Signal equality operator |
Expand All @@ -41,10 +41,10 @@ A list of help patches describing how each object works is <a href="../ressource
| **/** | | Compute the division of two numbers |
| **-** | | Compute the substraction of two numbers |
| **message** | | Send messages or list of messages |
| **slider** | | Graphical slider sending values between 0 and 1 |
| **toggle** | | A switch button |
| **bang** | | Send a bang message |
| **meter~** | | A peak amplitude vu meter |
| **slider** | | GUI sending values between 0. and 1. |
| **toggle** | | GUI sending 0 or 1 |
| **bang** | | GUI sending a bang message |
| **meter~** | | A Peak Program Meter GUI |
| **trigger** | *t* | Trigger events based on received data |
| **newbox** | | Empty new box |
| **errorbox** | | Error box |
Expand All @@ -53,8 +53,8 @@ A list of help patches describing how each object works is <a href="../ressource
| **print** | | Print messages into Kiwi console |
| **receive** | *r* | Receive messages from a sender bound to the same name |
| **loadmess** | | Output arguments as message when the patch is loaded |
| **delay** | | Delay messages as bang |
| **pipe** | | Delay any message |
| **delay** | | Delays messages as bang |
| **pipe** | | Delays any message |
| **metro** | | Output bang at regular time interval |
| **adc~** | | Receive audio signals from inputs or external devices |
| **dac~** | | Send audio signals to outputs or external devices |
Expand All @@ -66,9 +66,9 @@ A list of help patches describing how each object works is <a href="../ressource
| **delaysimple~**| | Simple variable delay line with optional feedback value |
| **scale** | | Convert a number from one range into another range |
| **gate** | | Route message to selected output |
| **switch** | | Output message receive in selected inlet |
| **switch** | | Output messages received in selected inlet |
| **gate~** | | Route received signal to selected output |
| **switch~** | | Ouput signal received in selected inlet |
| **switch~** | | Output signal received in selected inlet |
| **clip** | | Clip a number between a maximum and a minimum value |
| **clip~** | | Clip a signal between a maximum and a minimum value |
| **float** | | Store a float value |
31 changes: 31 additions & 0 deletions docs/software/versions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,37 @@

Kiwi follows the [Semantic Versioning Specification](http://semver.org/).

## v1.0.1

[select] :
- fix bad output when symbol match
- output input if doesn't match (was bang)
- Add [sel] alias

[number] :
- improve decimal drag
- Add patcherview shortcuts (f/i)
- Output only when value has changed

[number~] :
- updated draw method

[bang] :
- Add set method (flash without output)

[random] : (breaking-changes)
- default range is 0 (was 100)
- output random value between 0 and range-1 (was 0 and range)
- default seed is 0 (was 1)
- a seed of 0 means that it is initialized with an unpredictable time value.
- seed can now be set
- Add a *seed* method and remove the seed inlet
- remove range inlet when the range argument is specified

misc:
- Allow undo/redo of [message] and [comment] text edition.
- Remove "kiwi::model" in error message.

## v1.0.0

- Fix numerous bugs.
Expand Down

0 comments on commit f0d8ba0

Please sign in to comment.