Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 78 lines (51 sloc) 4.148 kb
b4e850f @steveklabnik Updating README.
steveklabnik authored
1 <pre>
2 ((( |||_| ///\ [[[_ (((
3 ))) || | \\/ [[_ )))
4 an artsy any-platform app kit
5 http://shoesrb.com
6 </pre>
edc1d80 @wilkie Merged.
wilkie authored
7
b4e850f @steveklabnik Updating README.
steveklabnik authored
8 # About Shoes
edc1d80 @wilkie Merged.
wilkie authored
9
b4e850f @steveklabnik Updating README.
steveklabnik authored
10 Shoes is the best little DSL for cross-platform GUI programming there is. It feels like real Ruby, rather than just another C++ library wrapper. If Gtk or wxWidgets is Rails, Shoes is Sinatra.
edc1d80 @wilkie Merged.
wilkie authored
11
b4e850f @steveklabnik Updating README.
steveklabnik authored
12 # Let me tell you a story about Shoes
edc1d80 @wilkie Merged.
wilkie authored
13
b4e850f @steveklabnik Updating README.
steveklabnik authored
14 Way way back in the day, there was a guy named \_why. He created a project known as [Hackety Hack](http://hackety-hack.com) to teach programming to everyone. In order to reach all corners of the earth, \_why decided to make Hackety Hack work on Windows, Mac OS X, and Linux. This was a lot of work, and so \_why decided to share his toolkit with the world. Thus, Shoes was born.
edc1d80 @wilkie Merged.
wilkie authored
15
b4e850f @steveklabnik Updating README.
steveklabnik authored
16 Everybody loved Shoes. Many apps were made, and put into [The Shoebox](http://the-shoebox.org/). But, one day, \_why left. In his memory, Team Shoes assembled, and carried on making Shoes. They released Shoes 3 in late summer 2010.
edc1d80 @wilkie Merged.
wilkie authored
17
b4e850f @steveklabnik Updating README.
steveklabnik authored
18 # So what do these Shoes look like?
edc1d80 @wilkie Merged.
wilkie authored
19
b4e850f @steveklabnik Updating README.
steveklabnik authored
20 Here's a little Shoes app. It's a stopwatch!
edc1d80 @wilkie Merged.
wilkie authored
21
b4e850f @steveklabnik Updating README.
steveklabnik authored
22 Shoes.app :height => 150, :width => 250 do
23 background rgb(240, 250, 208)
24 stack :margin => 10 do
25 button "Start" do
26 @time = Time.now
27 @label.replace "Stop watch started at #@time"
28 end
29 button "Stop" do
30 @label.replace "Stopped, ", strong("#{Time.now - @time}"), " seconds elapsed."
31 end
32 @label = para "Press ", strong("start"), " to begin timing."
33 end
34 end
edc1d80 @wilkie Merged.
wilkie authored
35
b4e850f @steveklabnik Updating README.
steveklabnik authored
36 Here's what it looks like:
edc1d80 @wilkie Merged.
wilkie authored
37
b4e850f @steveklabnik Updating README.
steveklabnik authored
38 ![shoes timer](https://github.com/shoes/shoes/raw/develop/manual-snapshots/simple-timer.png)
edc1d80 @wilkie Merged.
wilkie authored
39
b4e850f @steveklabnik Updating README.
steveklabnik authored
40 Pretty simple! For more samples, the manual, and a free book, check out [the Shoes website](http://shoesrb.com/).
edc1d80 @wilkie Merged.
wilkie authored
41
b4e850f @steveklabnik Updating README.
steveklabnik authored
42 # Using Shoes
edc1d80 @wilkie Merged.
wilkie authored
43
b4e850f @steveklabnik Updating README.
steveklabnik authored
44 If you'd like to use Shoes to develop some apps... awesome! It's super easy: Just go to the [downloads page on the Shoes website](http://shoesrb.com/downloads) and download a copy of Shoes for your platform. Mac OSX, Windows, and Linux supported!
edc1d80 @wilkie Merged.
wilkie authored
45
b4e850f @steveklabnik Updating README.
steveklabnik authored
46 After you install Shoes, run it! You'll get a window like this:
edc1d80 @wilkie Merged.
wilkie authored
47
b4e850f @steveklabnik Updating README.
steveklabnik authored
48 ![shoes main window](https://github.com/shoes/shoes/raw/develop/static/shoes_main_window.png)
edc1d80 @wilkie Merged.
wilkie authored
49
b4e850f @steveklabnik Updating README.
steveklabnik authored
50 You can then open any .rb file with Shoes code inside by choosing "Open an App." It'll open it up and run it, right away.
edc1d80 @wilkie Merged.
wilkie authored
51
b4e850f @steveklabnik Updating README.
steveklabnik authored
52 Once you're happy with your app, you can choose "Package an App" to wrap up your app as a .exe, .app, or a .run. Then you can share it with someone without a pair of Shoes to call their own.
edc1d80 @wilkie Merged.
wilkie authored
53
b4e850f @steveklabnik Updating README.
steveklabnik authored
54 # Making your own Shoes
edc1d80 @wilkie Merged.
wilkie authored
55
809626e Update to a link URL in the README
Carol Nichols authored
56 You can make your own pair of Shoes with a little bit of elbow grease. Since there are different instructions on each platform, we've got a page up on the [Shoes development wiki](http://github.com/shoes/shoes/wiki) about it. It's [right here](https://github.com/shoes/shoes/wiki/Building-Shoes).
edc1d80 @wilkie Merged.
wilkie authored
57
b4e850f @steveklabnik Updating README.
steveklabnik authored
58 # Shoes Around the Web
edc1d80 @wilkie Merged.
wilkie authored
59
b4e850f @steveklabnik Updating README.
steveklabnik authored
60 If you want to keep up to date with what's going on with Shoes, you can find us in various places:
edc1d80 @wilkie Merged.
wilkie authored
61
b4e850f @steveklabnik Updating README.
steveklabnik authored
62 * [Official Shoes Site](http://shoesrb.com/)
63 * [Source Code @ GitHub](http://github.com/shoes/shoes)
64 * [Issue tracker @ GitHub](http://github.com/shoes/shoes/issues)
65 * [Mailing List](http://librelist.com/browser/shoes/) (send an email to shoes@librelist.com to join)
66 * [Twitter account](http://twitter.com/shoooesrb)
67 * [Facebook page](http://www.facebook.com/pages/Shoes/132605040125019)
68 * IRC room on Freenode, #shoes
edc1d80 @wilkie Merged.
wilkie authored
69
b4e850f @steveklabnik Updating README.
steveklabnik authored
70 # Helping out with Shoes
edc1d80 @wilkie Merged.
wilkie authored
71
b4e850f @steveklabnik Updating README.
steveklabnik authored
72 So you'd like to lend a helping hand, eh? Great! We'd love to have you. To submit a patch to Shoes, just fork us, and send a pull request.
edc1d80 @wilkie Merged.
wilkie authored
73
b4e850f @steveklabnik Updating README.
steveklabnik authored
74 If you don't have any ideas yourself, take a look at the [Issue tracker](http://github.com/shoes/shoes/issues) and see if anything strikes your fancy. If you need help working on something, don't be afraid to post to the mailing list about it!
edc1d80 @wilkie Merged.
wilkie authored
75
ca85c45 @codeodor added a link to the wiki so people can find info easier!
codeodor authored
76 Be sure to [peer into the Shoes Wiki](https://github.com/shoes/shoes/wiki) for instructions on how to get the source code to build, and to learn more knowledge that will come in handy if you want to help out!
77
78 If you're not a programmer, you can help Shoes by talking about it! Blog posts, tweets, tell your neighbors, call your grandma, whatever! Share Shoes with everyone!
Something went wrong with that request. Please try again.