Permalink
Browse files

running with the naughty theme

experimenting with playing up the BDSM arch style. maximize the upside
of our risqué name…
  • Loading branch information...
1 parent d3d264f commit 72ca3d6ac860968895d2809dedbf130d408b31f6 @adrianrf adrianrf committed Aug 11, 2011
@@ -0,0 +1,11 @@
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-24992786-1']);
+ _gaq.push(['_setDomainName', '.beginrescueend.com']);
+ _gaq.push(['_trackPageview']);
+ _gaq.push(['_trackSocial', socialNetwork, socialAction]);
+
+ (function(){
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
View
@@ -13,7 +13,8 @@
%h1
About BDSM
%p
- BDSM started as a personal project to keep all of my various server side
+ BDSM started as a personal project to keep all of my various server-side
scripts together. It quickly evolved into a framework that I have been using
- on a large number of production systems since late 2009.
+ to keep a large number of production systems in a state of quivering, delightful obedience,
+ subject to my every whim, since late 2009.
View
@@ -12,21 +12,25 @@
%h1 The Basics of BDSM
%p
- First follow the
+ First, follow the
%a{:href => "/bdsm/install/"}
installation documentation
- and get BDSM running on your system.
+ to get BDSM running on your system. For most people, as long as you already have the short list of
+ %a{ :href => "/bdsm/prerequisites/" }
+ prerequisites,
+ this takes less than 90 seconds.
%p
As stated on the
%a{:href => "/"}
main page
- BDSM is a scripting management framework that happens to be written primarily
- in bash.
+ BDSM is a system-wide scripting management framework. BDSM happens to be written primarily
+ in bash -- but it supports all sorts of applications and tools, you can write extensions for it in pretty much any language you like. If zshell rocks your world, no problem: BDSM can get down and do the dirty deed daily with zshell, too, just as slick, baby.
%h2
Extensions
%p
BDSM is centered around the concept of extensions.
- Extensions can be thought of as a namespaced collection of scripts.
+ Extensions are namespaced collections of scripts.
+ Which means no permanent scarring when you make them play together, no matter how rough you get - BDSM makes sure they'll always dance safely and obediently to your tune.
%p
You can
%a{:href => "/extensions/"}
@@ -36,9 +40,10 @@
%h2
Actions
%p
- Within each extension there are a set of executable files in the bin/ directory.
- These are known as extension actions. These actions are what get exposed via
- the bdsm CLI as an API.
+ Each extension includes a set of executable files in its bin/ directory.
+ The executables power a given extension's individual repertoire of actions.
+ and some of them are very naughty indeed.
+ And these actions are fully exposed, and await (panting) your every playful whim -- via the all-powerful, yet sparse, trim and starkly-uncomplicated bdsm command-line.
%p
The general BDSM CLI for calling an extension action is,
%pre.code
@@ -54,25 +59,28 @@
%h2
Modules
%p
- When you write an extension you may call upon BDSM modules in order to use
- pre written functionality in a DSL form. This tends to greatly accelerate the
- development of system scripts.
+Firstly, you'll want to start out easy, by calling on the rich set of pre-written BDSM modules. They amount to an amazing toy-chest of deliciously wicked functionality that comes your way in easily-assimilated DSL form. You say it; they obey it.
%p
- Modules can be thought of as say a programming language's standard library
- where in any of that language's code files you may load the library and then
- start using it's functionality.
+ Modules operate a lot like a programming language's standard libraries do; load the library, then
+ go to town with its full functionality.
+ %p
+And when you have your system groveling obediently at your ankles, just begging to lick right between your toes in that oh-so-delicious favorite spot, you may could perhaps be completely satiated.
+What's that? No? Too easy? You need more; much, much more, from your abject slaves?
+ No problem! Writing your own exquisite-crafted extensions is far from being some huge test of your personal capacity for tolerating pain. Not at all. In fact, we bet you'll squeal with delight!
+ %p
+ Developing your own powerful system scripts isn't just electrifyingly fast with BDSM, it's more stimulating than plugging a 12-foot Van De Graaf generator directly into nickel-plated nipple clamps!
%p
You can
%a{:href => "/extensions/"}
read more about extensions
in the documentation.
%h2
- Language Agnositc
+ Language-Agnostic
%p
- BDSM is called the 'Bash ...' because that is what it is written in primarily.
+ THe "B" in BDSM means 'Bash...' - not (sadly) because it's the quaint British synonym for fisticuffs that we all secretly wish it were... but simply because that is what it is written in primarily: the Bourne-Again Shell. The world's most popular command-line interpreter
+ (sorry, no, Bill: DOS doesn't count. and don't talk to me about Cisco, darling - that nasty greasy stuff just goes sour and smelly in nothing flat. And it marks the carpet something awful.)
%p
That being said, each and every extension action may be written in any
language. The requirement for an extension action is that it is an executable
file of a type that the system recognizes.
-
@@ -12,25 +12,27 @@
%h1
BDSM Configuration
%p
- BDSM has a configuration directory located in $bdsm_config_path which for a
- typical installation as user to their
- $HOME directory will be located in ~/.bdsm/config/
+ BDSM's configuration directory is located at $bdsm_config_path, which for a
+ typical installation will be located in your $HOME directory, at
+%pre.code
+ :preserve
+ ~/.bdsm/config/
%h2
Defaults
%p
- bdsm has a set of defaults recorded in the file
+ BDSM's shipping defaults are stored in the file
%pre.code
:preserve
$bdsm_path/config/db
%p
- This file is replaced each time you upgrade bdsm so do not edit it.
+ Note: this file is replaced each time you upgrade bdsm, so do not edit it! If you need to, override it instead.
%h2
Overriding Default Settings
%p
- In order to override bdsm's default settings, simply place the appropriate key=value entry into the file
+ To override bdsm's default settings, simply add appropriate key=value entry pairs into the file
%pre.code
:preserve
$bdsm_path/config/user
%p
- bdsm will then use these settings instead of bdsm's defaults.
+ bdsm will then use these settings, instead of the built-in defaults.
View
@@ -1,13 +1,13 @@
%h1 Installing BDSM
%p
- You may install either the latest release or the latest development git HEAD.
+ You may install either the latest release version of BDSM; or you can choose the latest up-to-the-minute development snapshots as they come, by summoning git HEAD.
%h2
Latest Release
%p
- To install the latest BDSM framework release, run the following commands in
+ To install the latest BDSM release, run the following commands in
your shell:
%pre.code
@@ -21,10 +21,10 @@
./install
%p
- Note that the first two lines can be omitted if you want to install from your
+ Note: you can skip the first two lines if you prefer to install from your
current directory.
%p
- The bdsm binary will be located in /usr/local/bin and bdsm itself will be
+ The bdsm binary will be located in /usr/local/bin, and bdsm itself will be
located in /usr/local/bdsm.
%p
If you do not already have /usr/local/bin in your path, add it in /etc/profile
@@ -33,9 +33,9 @@
PATH="$PATH:/usr/local/bin" ; export PATH
%h2
- Latest development (git HEAD)
+ Latest Development Snapshot (git HEAD)
%p
- In order to install the latest BDSM development (git HEAD),
+ For the latest BDSM development, "live" (git HEAD):
%pre.code
:preserve
mkdir -p /usr/local/src &&
@@ -12,11 +12,11 @@
%h1 BDSM Prerequisites
%p
- BDSM uses the following standard *nix tools, some are builtin to bash:
+ BDSM depends on these standard *nix tools:
%ul
%li bash (>= 3.2)
- %li awk
- %li sed
+ %li awk <- included in gnu-coreutils
+ %li sed <- included in gnu-coreutils
%li grep
%li which
%li ls
@@ -27,3 +27,4 @@
%li bunzip2
%li git (> 1.7)
+
@@ -11,21 +11,21 @@
%hr
%h1
- Upgrading bdsm
+ Upgrading BDSM
%p
- bdsm supports two ways of upgrading itself, one to the latest gem and the other to the latest repository source.
+ BDS< supports two upgrade methods: one is to update to the latest gem (a full release version); the other is to the latest repository snapshot ("live" development version).
%h3
Upgrading to the latest release
%pre.code
:preserve
∴ bdsm get latest
%p
- Will download and install the latest release.
+ Downloads and installs the latest full release as a gem.
%h3
Upgrading to the latest repository source
%pre.code
:preserve
∴ bdsm get head
%p
- will obtain the latest bdsm repository source and run ./install from that repository.
+ Obtains a local version of the latest BDSM repository sourcecode, and runs ./install directly from that repository.
@@ -24,3 +24,5 @@
%a{:href => "http://www.blueboxgrp.com/"}
Blue Box Group, LLC
donates a VPS to run BDSM's website on.
+ %li
+ [wayneeseguin: who else should we be identifying here???]
@@ -2,8 +2,8 @@
%a{ :name => "thanks" }
%h1
- Many Thanks
+ Many Thanks!
%h3
- Thank you so much to those of you who private beta tested BDSM and provided much excellent feedback.
+ Thank you so much to those of you who invested the time and took the risk to be private beta-testers for BDSM, and who have provided much excellent feedback. Your contributions have made BDSM what it is at its best; its shortcomings are mine alone.
@@ -14,42 +14,47 @@
%p
So, you want to contribute to BDSM? Excellent, we can always do with
- an extra helping hand (or two). If you're not a great coder, we always
- appreciate people helping out in the channel and giving support. Riding shotgun
- on a remote pair programming session is also exteremely useful.
- If you are interested in coding by yourself, there are a few things you will
- need to know and a few things that make the process in general a lot smoother.
+ an extra helping hand (or two).
+%p
+ You don't have to be a great coder to pitch in. We always
+ appreciate people helping out in the IRC channel and giving support.
+
+%p
+ We also greatly appreciate documentation patches, submitted from the bdsm-site
+ repository (url below).
+
+%p
+ If you do have programming chops, riding shotgun
+ on a remote pair-programming session is an extremely useful way to build awarenss and support for BDSM's benefits.
%p
- We also greatly appreciate documentation patches, submitted from the bdsm-site
- repository (url below).
+ And if you are interested in adding your own coding contributions to BDSM, there are a few things you should be aware of; and a few things in particular that will make the whole process a lot smoother overall.
%h2 General Guidelines
%ol
%li
- When contributing, either keep patches simple or work on a topic branch - this
- makes it easier for us to merge in discrete changes and means you always keep
- things seperate where needed.
+ When contributing, please either try to keep your patches simple, or work on a topic branch - this
+ makes it a lot easier for us to merge in discrete changes, and means you can always keep
+ things separated out when needed.
%li
- The code has to be compatible with bash version 3.2.48 and beyond. The newer
- the better.
+ All code must be compatible with bash 3.2.48 and later. (The newer the better, actually.)
%li
- Clean code is preferred - if in doubt, take a look at other already written
- scripts and refactor.
+ Clean code is highly preferred - if in doubt, take a look at other already-written
+ BDSM scripts, then refactor from there.
%li
- Drop into the IRC room (#beginrescueend on freenode) and chat with
- wayneeseguin if you have a task in mind.
- You may find someone else has already started on it.
+ Drop into our IRC room (#beginrescueend on freenode) and chat with
+ wayneeseguin or mpapis if you have a particular task in mind:
+ we'll be happy to let you know if perhaps someone else has already started on it; and we can connect you, if perhaps you might like to team up.
%h2 Handy Tips
%ol
%li
- Generally, working in a clone of the repository is by far the best way
- to go and from there it is simple to update your main install.
- All you need to do is change to the project repository directory that you
- cloned (e.g. ~/projects/bdsm), and run:
+ Generally, working with your own clone of the primary BDSM repository is by far the best way
+ to go; from there, it's as simple as it can git (sorry!) to update your main install.
+ All you need to do is to pop into the project repository directory that you
+ cloned, (e.g. ~/projects/bdsm), and run:
= root_command "./install"
%h2 Repositories
Oops, something went wrong.

0 comments on commit 72ca3d6

Please sign in to comment.