Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
wayneeseguin committed Apr 12, 2011
1 parent 48f1edf commit ca414e2
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README
Expand Up @@ -13,7 +13,9 @@ The site requires that you have ruby 1.9.2 running in your environment.
(Although you can manually use something else, this is what is setup in the
.rvmrc file currently.)

You can do this with RVM by typing the following at the command line:
You can do this with RVM (https://rvm.beginrescueend.com/rvm/install,
http://rvm.beginrescueend.com/rvm/basics/) by typing the following at the
command line:

rvm install 1.9.2

Expand Down Expand Up @@ -52,8 +54,9 @@ You can use Nanoc's AutoCompile feature:
== Update Submission

Once you are satisfied with your changes to the documentation push it back to
your github fork and initiate a pull request.
your github fork and initiate a pull request. Please use topic branches.

== Thanks

Thank you for taking the time to work on the BDSM website!!!

64 changes: 64 additions & 0 deletions doc/thoughts.txt
@@ -0,0 +1,64 @@
Thoughts:

1. Why? What's the pain point/frustration this solves?
a. Gimme a logline: Like "Top Gun with fanboats".
i. Is it rack for server maintenance? or RVM on steroids?
ii. Is it more for development, system administration, or deployment?
iii. What's the benefit of writing extensions for it vs. a gem, etc.?

2. Most devs don't typically write gems, they are consumers. Who are the consumers here? What's the benefit?

Contribution guidelines have copy-paste issues from RVM


Early potential structure:

What is BDSM?
a. Description/logline
b. Example
c. Screencast

Who is it for?
a. Sysadmins or Devs? Both?
b. Situations/pain points
c. Benefits/features
i. RVM Gemset integration

Getting Started
a. Prereqs
b. Installation
c. Your first project/Hello World

Digging deeper (Integration?)
a. Scenarios
i. Scripting with BDSM

Extensions
a. What are extensions?
b. Why would I use them?
c. Where do I get them?
d. How do I install them?
e. How do I use them?
i. Listing
ii. deleting
iii. emptying
e. What if I want to create my own?
i. Creating
ii. See Development (?)

Development
a. Github repo
b. Pivotal Tracker Project
c. Contributing tips
d. Debugging

Help & Support
a. FAQ
b. Troubleshooting
c. Contact/IRC

Credits
a. Contributions
b. How you can help
i. Code
ii. Donate/Funding

0 comments on commit ca414e2

Please sign in to comment.