Skip to content

Commit

Permalink
add md files for #1
Browse files Browse the repository at this point in the history
  • Loading branch information
Cecil committed Nov 24, 2016
1 parent 83bb55d commit 075f511
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 0 deletions.
46 changes: 46 additions & 0 deletions manual-en.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Shoes
=====

## Welcome to the Shoes 3.2 wiki

This wiki contains information that's important to anyone who wants learn more about Shoes. There are things that are not in the built-in manual you might like to know about.

## Beginners

Just go to the [Shoes website](http://shoesrb.com/) and download Shoes. You can also find the [Shoes manual](http://shoesrb.com/manual/Hello.html) and a book, [Nobody Knows Shoes](http://cloud.github.com/downloads/shoes/shoes/nks.pdf). That'll get you started building applications with Shoes.

Have a question? - You should join the Shoes mailing list by sending an email to [email protected] and ask. That's also a good place to discuss bugs if you don't want to get a github account.

Need a Beginners Guide to Ruby? - I recommend [Programming Ruby, The Pragmatic Programmers Guide](https://7chan.org/pr/src/ruby.pdf) aka the PickAxe book. It doesn't cover Shoes - it's for Ruby. I suggest buying the hardcover book - my copy is always open to some reference page or another.

## Intermediate Level
Perhaps you already know everything about Ruby (congrats!) or you're a command line maven and Shoes doesn't do what you want. Or maybe you're curious to read more. Shoes is all about learning and exploring. If you see something below that you don't understand, just file it away for further cogitating. Reading is not harmful. Acting without knowledge can be harmful but it's trait I live with.

Actually, Shoes might do what you want if someone would write it down so you can find it so you can experiment and learn more. You should join the mailing list and get a github account and file bug reports (or answer them) at the [Shoes issue tracker](http://github.com/shoes3/shoes/issues)

* Dude, where's the secret files? [[Where are files kept]]
* Shoes command line [[Command-line]]
* Shoes and Ruby Gems [[Gems]]
* Cobbler [[Cobbler]]
* Packaging [[Packaging]]
* Development tools [[Developers Tools]]
* Shoes is not Ruby [[Shoes is not Ruby]]

## I want to dig deep into how Shoes works and fix some bugs. 'C' doesn't scare me! Makefiles and Rakefile? I can handle that!

Awesome! We'd love to have you help out with Shoes. Here's some resources you're gonna need: (they may be out of date, but you can handle that).

* Development tools [[Developers Tools]]
* [[Building Shoes]] Put on your fire hose gear.
* [[Creating Icons]] Icons for packaging.
* The [Shoes issue tracker](http://github.com/shoes3/shoes/issues), where bug reports go.
* You should join the Shoes mailing list by sending an email to [email protected]
* [[The Future of Shoes]]
* [[A Developer's Tour Through Shoes]] A bit outdated.
* [[A Developer's Tour Through The Magic Packager]] Even more outdated.

## I hate 'C' and Makefiles. I like jRuby!

OK. Fine. You want to follow/join the [Shoes 4 project](https://github.com/shoes/shoes4)


27 changes: 27 additions & 0 deletions manual-en_.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
= Introduction =

This is a section.

Another.

== Eating Shoes ==

This is a method.

Another.

= Cecil Coupe =

This is Cecil Coupe who has made Shoes 3.2 possible.

Thank you, Cecil.!{:margin_left => 60}222691.png!

== More ==

Cecil has its own API. Nobody knows _why.

Or when_.

=== ask_cecil(question: a string) » Shoes::Philosophy ===

You can ask Cecil any questions and get an answer. Sometimes even a bit more about the meaning of life.

0 comments on commit 075f511

Please sign in to comment.