-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
174 lines (125 loc) · 7.85 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<link href='https://fonts.googleapis.com/css?family=Chivo:900' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>Shoebot!</title>
</head>
<body>
<div id="container">
<div class="inner">
<header>
<h1>Shoebot</h1>
<h2>Generate vector graphics with Python</h2>
</header>
<section id="downloads" class="clearfix">
<a href="https://github.com/shoebot/shoebot/zipball/master" id="download-zip" class="button"><span>Download .zip</span></a>
<a href="https://github.com/shoebot/shoebot/tarball/master" id="download-tar-gz" class="button"><span>Download .tar.gz</span></a>
<a href="https://github.com/shoebot/shoebot" id="view-on-github" class="button"><span>View on GitHub</span></a>
</section>
<hr>
<section id="main_content">
<h1>
<a name="shoebot" class="anchor" href="#shoebot"><span class="octicon octicon-link"></span></a>Shoebot</h1>
<p>Shoebot is a Python graphics robot. Instead of drawing with your mouse, you write code to create images. The syntax is simple and aimed at people without a specific programming background -- though its advanced features might be useful for code ninjas too!</p>
<p>It takes a Python script as input, which describes a drawing process, and outputs a vector graphic in a common open standard format: SVG, PDF, PostScript or PNG. It works through simple text files, and scripts can describe their own GUIs for controlling variables interactively. It can also be used as a Python module, a plugin for Python-scriptable tools such as Inkscape, and run from the command line without a GUI for automated tasks. </p>
<p>Shoebot is a port/rewrite of <a href="http://nodebox.net/code/index.php/Home">Nodebox 1</a>. It was also inspired by <a href="http://drawbot.com">DrawBot</a> and <a href="http://shoesrb.com/">Shoes</a>. Thus, "Shoebot".</p>
<h2>
<a name="what-you-need" class="anchor" href="#what-you-need"><span class="octicon octicon-link"></span></a>Install dependencies</h2>
<p>Shoebot runs on Python 2.7, which is most probably what you already have installed.</p>
<p>The first step is to install the appropriate dependencies.
If this is your first time using Shoebot, you'll want to install all of them.</p>
<p>In Debian/Ubuntu:</p>
<pre><code>sudo apt-get install libjpeg-dev python-cairo python-gtk2 \
python-gobject python-rsvg python-imaging</code></pre>
<p>In Fedora:</p>
<pre><code>sudo yum install libjpeg-devel pycairo pygtk2 \
pygobject2 gnome-python2-rsvg python-pillow</code></pre>
<h2>
<a name="installing-shoebot" class="anchor" href="#installing-shoebot"><span class="octicon octicon-link"></span></a>Install Shoebot</h2>
<p>You can get the latest flavor of Shoebot <a href="https://github.com/shoebot/shoebot">from GitHub</a>, or using these direct links:</p>
<ul>
<li><a href="https://github.com/shoebot/shoebot/zipball/master">Zip file</a></li>
<li><a href="https://github.com/shoebot/shoebot/tarball/master">Tar.gz file</a></li>
</ul>
You can also clone the repository using Git from the command-line.
<pre><code>mkdir ~/src
cd ~/src
git clone https://github.com/shoebot/shoebot.git</code></pre>
<p>You should now see a new shoebot/ directory. The only remaining step is to install it proper:</p>
<pre><code>cd shoebot
sudo python setup.py install
</code></pre>
<h2>
<a name="running-shoebot-from-the-console" class="anchor" href="#running-shoebot-from-the-console"><span class="octicon octicon-link"></span></a>Running Shoebot from the console</h2>
<p>Using the Shoebot console runner is straightforward:</p>
<pre><code>sbot inputfile.bot</code></pre>
<p>This command will run the <code>inputfile.bot</code> script, and create an output image file – <code>output.svg</code> by default. You'll want to specify your own filename, and for this there's the <code>-o</code> or <code>--output</code> option:</p>
<pre><code>sbot inputfile.bot -o image.png</code></pre>
<p>The allowed extensions for the output filename are .svg, .ps, .pdf and .png.</p>
<p>You can find many example Shoebot scripts in <code>/usr/share/shoebot/examples</code>.</p>
<p>Shoebot can also run in a window, which is useful for quick previews, as well
as realtime manipulation of parameters. For this, just use the <code>--window</code> or <code>-w</code> option:</p>
<pre><code>sbot -w inputfile.bot
</code></pre>
<p>For a list of extra options, type</p>
<pre><code>sbot -h
</code></pre>
<h2>
<a name="documentation" class="anchor" href="#documentation"><span class="octicon octicon-link"></span></a>Documentation</h2>
<p>You can find the current docs at <a href="http://shoebot.readthedocs.org/">ReadTheDocs</a>.</p>
<p>Shoebot documentation can also be generated locally using sphinx. First, install it::</p>
<pre><code>pip install sphinx
</code></pre>
<p>The following commands will output the HTML docs::</p>
<pre><code>cd doc
make html
</code></pre>
<p>The documentation should now be available in <code>doc/build</code>.</p>
<h2>
<a name="further-reading" class="anchor" href="#further-reading"><span class="octicon octicon-link"></span></a>Further reading</h2>
<p>For a great intro to the Nodebox/Shoebot language, be sure to check the Nodebox tutorials at <a href="http://nodebox.net/code/index.php/Tutorial">http://nodebox.net/code/index.php/Tutorial</a> .</p>
<p>The Shoebot documentation has quite a lot more information on what you can do with Shoebot, such as:</p>
<ul>
<li>running Shoebot as a Python module</li>
<li>using the socketserver to have other programs control a Shoebot script</li>
<li>using Shoebot to generate images via a CGI script</li>
</ul><h2>
<a name="links" class="anchor" href="#links"><span class="octicon octicon-link"></span></a>Links</h2>
<ul>
<li><a href="http://shoebot.net">Website</a></li>
<li><a href="http://shoebot.readthedocs.org">Documentation</a></li>
<li><a href="http://lists.tinkerhouse.net/listinfo.cgi/shoebot-devel-tinkerhouse.net">Mailing list</a></li>
<li><a href="http://github.com/shoebot/shoebot">Source browser (Github)</a></li>
<li><a href="http://github.com/shoebot/shoebot/issues">Issue tracker</a></li>
</ul>
<h2><a name="license" class="anchor" href="#license"><span class="octicon octicon-link"></span></a>License</h2>
<p>Copyright (C) 2007-2012 The Shoebot authors (Stuart Axon, Dave Crossland, Francesco Fantoni, Ricardo Lafuente, Sebastian Oliva)
Originally developed by Ricardo Lafuente with the support of the Piet Zwart Institute, Rotterdam.</p>
<pre><code>This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
</code></pre>
</section>
<footer>
Shoebot is maintained by <a href="https://github.com/shoebot">shoebot</a><br>
This page was generated by <a href="http://pages.github.com">GitHub Pages</a>. Tactile theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.
</footer>
</div>
</div>
</body>
</html>