summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md25
-rw-r--r--docs/Rakefile5
-rw-r--r--docs/default_manpage.md22
3 files changed, 52 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..58e7dca7
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,25 @@
+Documentation
+=============
+
+The jq website, manpages and some of the tests are generated from this
+directory. The directory holds a [Bonsai](http://tinytree.info)
+website, and the manual is a YAML file in `content/3.manual`.
+
+To build the documentation (including building the jq manpage), you'll
+need a working Ruby setup. The easiest way to get one is to install
+RVM and Ruby 1.9.3 like so:
+
+ \curl -L https://get.rvm.io | bash -s stable --ruby=1.9.3
+
+After that finishes installing, you'll need to make sure RVM is on
+your path by doing `source $HOME/.rvm/scripts/rvm`, or just opening a
+new shell. See <http://rvm.io> for more info on RVM.
+
+Once RVM is installed, you can install all the dependencies for jq's
+documentation build by running this from the `docs` directory:
+
+ bundle install
+
+When bundle manages to install the dependencies, rerun `./configure`
+in the jq root directory and then the Makefile will be able to
+generate the jq manpage.
diff --git a/docs/Rakefile b/docs/Rakefile
index 356f7111..f8072072 100644
--- a/docs/Rakefile
+++ b/docs/Rakefile
@@ -120,6 +120,10 @@ task :manpage do
end
end
+task :manpage_default => ["default_manpage.md"] do
+ puts Ronn::Document.new("default_manpage.md").convert('roff').gsub(/<\/?code>/,"")
+end
+
task :mantests do
load_manual['sections'].each do |section|
(section['entries'] || []).each do |entry|
@@ -132,3 +136,4 @@ task :mantests do
end
end
end
+
diff --git a/docs/default_manpage.md b/docs/default_manpage.md
new file mode 100644
index 00000000..f1a29a72
--- /dev/null
+++ b/docs/default_manpage.md
@@ -0,0 +1,22 @@
+jq(1) -- Command-line JSON processor
+====================================
+
+## DESCRIPTION
+
+`jq` can transform JSON in various ways, by selecting, iterating,
+reducing and otherwise mangling JSON documents.
+
+This version of `jq` was built without a manual, so this manpage is a
+stub. For full documentation of the `jq` language, see:
+
+ http://stedolan.github.com/jq
+
+## BUGS
+
+Presumably. Report them or discuss them at:
+
+ https://github.com/stedolan/jq/issues
+
+## AUTHOR
+
+Stephen Dolan `<mu@netsoc.tcd.ie>`