mojavelinux pushed to rubygem-asciidoctor (epel7). "add README"

[notifications at fedoraproject.org]

From 35d66158a3168e23a743d130c30237bbcdb36b85 Mon Sep 17 00:00:00 2001
From: Dan Allen <dan.j.allen at gmail.com>
Date: Wed, 19 Dec 2012 04:37:43 -0700
Subject: add README


diff --git a/README.asciidoc b/README.asciidoc
new file mode 100644
index 0000000..546dcbf
--- /dev/null
+++ b/README.asciidoc
@@ -0,0 +1,85 @@
+[float]
+= rubygem-asciidoctor: Asciidoctor RPM package spec
+:version: 0.0.8
+
+This repository hosts the RPM package spec file for the https://github.com/erebor/asciidoctor[Asciidoctor] library. The package is named `rubygem-asciidoctor`.
+
+== Prerequisites
+
+This RPM spec was developed for Fedora (17 or better), but may be useful for other RPM-based systems.
+
+== Preparing your environment
+
+You first need to install the packages necessary to build the RPM. Begin by installing the `@fedora-packager` group.
+
+ yum install @fedora-packager
+
+Next, clone this repository and switch to it:
+
+ git clone git://github.com/mojavelinux/rubygem-asciidoctor.git 
+ cd rubygem-asciidoctor
+
+Finally, install the packages that this build requires:
+
+ yum-builddep rubygem-asciidoctor.spec
+
+Next, we need to put the package source and patches in place.
+
+== Preparing the sources
+
+You can build RPMs as a non-privileged user, though you need to prepare the directories first. Let's use the directory rpmbuild in our `$HOME` directory:
+
+ echo "%_topdir %(echo $HOME)/rpmbuild" > $HOME/.rpmmacros
+
+You'll also need to create all the required folders:
+
+ mkdir -p $HOME/rpmbuild/{BUILD,BUILDROOT,RPMS,SOURCES,SPECS,SRPMS}
+
+Next, grab the Asciidoctor gem (the sources) and put it into the `$HOME/rpmbuild/SOURCES` directory:
+
+[subs="attributes"]
+ wget -O $HOME/rpmbuild/SOURCES/asciidoctor-{version}.gem http://rubygems.org/gems/asciidoctor-{version}.gem
+
+Finally, copy the `.patch` files from this repository to the same directory:
+
+ cp *.patch $HOME/rpmbuild/SOURCES/
+
+You're now ready to build the RPM.
+
+== Building the RPM
+
+With everything in place, building the RPM is easy!
+
+ rpmbuild -ba rubygem-asciidoctor.spec
+
+If all goes well, both the binary and source RPMs will emerge in the `$HOME/rpmbuild/RPMS/noarch` and `$HOME/rpmbuild/SRPMS` directories, respectively.
+
+== Installing the RPM
+
+There's nothing special about installing this RPM. I recommend using `yum` because it will install any dependencies that the package requires (though you should already have them if you built the RPM).
+
+[subs="attributes"]
+ yum localinstall $HOME/rpmbuild/RPMS/noarch/rubygem-asciidoctor-{version}.rpm
+
+Now, it's time to start using Asciidoctor!
+
+== Basic Asciidoctor usage
+
+Create a file named asciidoctor-test.rb and populate it with the following code:
+
+----
+require 'asciidoctor'
+
+content = "= My First Document\n\nRender me some **HTML**!"
+puts Asciidoctor::Document.new(content.lines.entries).render
+----
+
+Now execute the file with Ruby:
+
+ ruby asciidoctor-test.rb
+
+You should see the HTML output to your terminal. You can update your script to write it to a file, or just redirect the output:
+
+ ruby asciidoctor-test.rb > test.html
+
+Open up your browser to see the result!
-- 
cgit v0.10.2


	http://pkgs.fedoraproject.org/cgit/rubygem-asciidoctor.git/commit/?h=epel7&id=35d66158a3168e23a743d130c30237bbcdb36b85