Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
qdot committed Oct 3, 2010
1 parent 7424c0e commit da8c5d4
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 36 deletions.
4 changes: 4 additions & 0 deletions ChangeLog.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
np_nifalcon ChangeLog
===========================

2010-10-02 Kyle Machulis <kyle@nonpolynomial.com>
* Release v1.6.2
* Added sleep_time message for resetting sleep values
* Fixed some threading issues
2009-09-20 Kyle Machulis <kyle@nonpolynomial.com>
* Release v1.5
* Rewrote most of the external, many fixes to stability
Expand Down
53 changes: 18 additions & 35 deletions README.txt → README.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
===================================
np_nifalcon Max/MSP and Pd External
===================================
== np_nifalcon Max/MSP and Pd External ==

by Kyle Machulis <kyle@nonpolynomial.com>
Nonpolynomial Labs - http://www.nonpolynomial.com
Expand All @@ -10,68 +8,53 @@ Contributors:
Edgar Berdahl
http://ccrma.stanford.edu/~eberdahl/

===========
Description
===========
== Description ==

np_nifalcon is an external for either Max/MSP or Puredata to control the Novint Falcon. It is based on libnifalcon:

http://libnifalcon.nonpolynomial.com

Portability of source between Max and Pd is available thanks to flext

Max: http://www.cycling74.com
Pd: http://www.puredata.info
Flext: http://www.parasitaere-kapazitaeten.net/ext/flext/
- Max: http://www.cycling74.com
- Pd: http://www.puredata.info
- Flext: http://puredata.info/Members/thomas/flext

===========================
Novint Falcon Information
===========================
== Novint Falcon Information ==

More information about the Novint Falcon can be found at

http://libnifalcon.sf.net
- Product Website - http://home.novint.com
- libnifalcon Cross Platform Open Source driver - http://libnifalcon.nonpolynomial.com

============
Installation
============
== Installation ==

- Put the .mxo(Mac)/.mxe(Windows) or .pd_[platform] file in a directory that Max/Pd will search for externals (Max: Options -> File Preferences -> Other Folders, Pd: Options -> Paths)
- Max: Put the .help (Max4) or .maxhelp (Max5) file in the max-help directory of your Max/MSP installation

=========================
Platform Specifics Issues
=========================
== Platform Specifics Issues ==

-------
Windows
-------
=== Windows ===

- Make sure the falcon is directly connected to your machine, do not go through a USB hub.
- Make sure the falcon is DIRECTLY CONNECTED to your machine. DO NOT go through a USB hub.

----
OS X
----
=== OS X ===

- Use a powered USB hub between the falcon and your machine.
- Make sure the falcon IS NOT DIRECTLY CONNECTED TO YOUR MACHINE. ONLY CONNECT THROUGH A POWERED USB HUB.

-----
Linux
-----
=== Linux ===

- Use a powered USB hub between the falcon and your machine.
- Make sure the falcon IS NOT DIRECTLY CONNECTED TO YOUR MACHINE. ONLY CONNECT THROUGH A POWERED USB HUB.
- np_nifalcon requires either root access (i.e. running pd under sudo) or correct udev based USB permissions to run as non-root. If you're using a udev based system, check out the udev sample files in the linux directory of the libnifalcon source distribution (v1.0 beta 1 and later)

=========
Licensing
=========
== Licensing ==

np_nifalcon is covered under the BSD License, but since it's based on flext, it's GPL. Damn you, viral licensing.

Copyright
-------------------
np_nifalcon, Copyright 2007-2009 Kyle Machulis/Nonpolynomial Labs
np_nifalcon, Copyright 2007-2010 Kyle Machulis/Nonpolynomial Labs
-------------------

Expand Down
2 changes: 1 addition & 1 deletion np_nifalcon.flext.cpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Implementation file for Novint Falcon Max/Pd External
*
* Copyright (c) 2005-2009 Kyle Machulis/Nonpolynomial Labs <kyle@nonpolynomial.com>
* Copyright (c) 2005-2010 Kyle Machulis/Nonpolynomial Labs <kyle@nonpolynomial.com>
*
* More info on Nonpolynomial Labs @ http://www.nonpolynomial.com
*
Expand Down

0 comments on commit da8c5d4

Please sign in to comment.