Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 77 lines (51 sloc) 2.676 kB
c905b39 @deanm Not great but better 1 line explaination in README.
authored
1 Plask is a programming environment for multimedia and computational design.
aa94ac8 @deanm Add a README.
authored
2
82cbd4a @deanm Some README updates, more details about building and running from sou…
authored
3 www.plask.org
4
5
6 - Getting Plask
7
8 For the common user, it is best to use the binary distribution provided at
9 www.plask.org. If you're interested in building and running from source, the
10 following section should help you get started.
11
12
13 - Building and running from source
da1fd49 @deanm Add some building details to the README.
authored
14
15 Plask integrates together quite a few pieces of technology, which unfortunately
16 makes the build process more complicated. It is possible to do a boostrapped
17 build, where you only build the Plask source file, but use prebuilt object
18 files for Plask's dependencies. Run the fetch_deps.sh script to download and
19 extract a copy of these prebuilt dependencies. When fetching new source
20 changes to Plask, you will have to be aware if there have been any changes to
21 the prebuilt dependencies, and if so, to run fetch_deps.sh again.
22
82cbd4a @deanm Some README updates, more details about building and running from sou…
authored
23 For example, to build from a completely new checkout would look something like:
24
25 $ sh fetch_deps.sh
36f3eae @notlion Fix xcode build command for xcode 4.
notlion authored
26 $ xcodebuild -project plask.xcodeproj -configuration Release -target Plask
82cbd4a @deanm Some README updates, more details about building and running from sou…
authored
27
28 This should produce Plask.app. For some technical and design reasons, Plask.app
29 is effectively a commandline application inside a bundle. For example, running
30 Plask.app/Contents/MacOS/Plask on the command line will start a Node-style REPL
31 loop, an interactive JavaScript shell of sorts.
32
33 Pass a filename on the command line to run that JavaScript file.
34
35 NOTE: To ease development, the Plask.app built has a symlink to plask.js in
36 the source. This allows you to edit plask.js in the source repository without
37 having to rebuild the project.
38
39 A separate project, PlaskLauncher, creates the UI application for launching
40 Plask by dragging/dropping or File->Open.
41
42
43 - Creating standalone applications
44
45 When Plask.app is launched, it will look for a file named main.js inside of
46 the bundle (in Contents/Resources). This allows you to easily create
47 standalone applications by copying Plask.app and putting your JavaScript source
48 inside of the bundle.
49
50 NOTE: When running "bundled", the current working directory will likely be
51 different from running Plask on the command line. Generally this means if you
52 open files you should open a path relative to __dirname, which is Node's global
53 variable for the directory that your JavaScript file is in.
54
55
da1fd49 @deanm Add some building details to the README.
authored
56 - Credits
57
82cbd4a @deanm Some README updates, more details about building and running from sou…
authored
58 Released under the BSD license. Full details in the included LICENSE file.
aa94ac8 @deanm Add a README.
authored
59
60 (c) 2010, Dean McNamee <dean@gmail.com>
61
62 This software contains code and ideas from the fantastic:
63
64 Nicolas Garcia Belmonte
65 Thatcher Ulrich
66 Ryan Alexander
67 Marcin Ignac
68
69 Built with the fantastic:
70
71 V8 JavaScript Engine
72 Skia rasterization library
73 NodeJS
74 Cocoa and OpenGL
75 FreeImage
689a128 @deanm Add Syphon to the list of libraries.
authored
76 Syphon
Something went wrong with that request. Please try again.