Skip to content

Commit

Permalink
Introduce nRonn 0.10.1.pre2 (#3)
Browse files Browse the repository at this point in the history
Signed-off-by: Takuya Noguchi <[email protected]>
  • Loading branch information
tnir authored Aug 1, 2022
1 parent 5c3da40 commit 9b0427c
Show file tree
Hide file tree
Showing 20 changed files with 87 additions and 107 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ ronn.5
ronn.7
ronn*.markdown
ronn*.html
ronn-ng-*.gem
*.gem
.bundle
2 changes: 1 addition & 1 deletion .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

File renamed without changes.
10 changes: 5 additions & 5 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# This is a list of people who have contributed code or ideas to ronn -- for
# copyright purposes or whatever.

Ryan Tomayko <http://github.com/rtomayko>
Chris Wanstrath <http://github.com/defunkt>
Suraj N. Kurapati <http://github.com/sunaku>
Hallison Batista <http://github.com/hallison>
Andrew Janke <http://github.com/apjanke>
Ryan Tomayko <https://github.com/rtomayko>
Chris Wanstrath <https://github.com/defunkt>
Suraj N. Kurapati <https://github.com/sunaku>
Hallison Batista <https://github.com/hallison>
Andrew Janke <https://github.com/apjanke>
16 changes: 9 additions & 7 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,30 +1,32 @@
PATH
remote: .
specs:
ronn-ng (0.10.1.pre1)
nronn (0.10.1.pre2)
kramdown (~> 2.1)
kramdown-parser-gfm (~> 1.0.1)
mustache (~> 1.0)
nokogiri (~> 1.9, >= 1.9.0)
nokogiri (~> 1.11, >= 1.11.0)

GEM
remote: https://rubygems.org/
specs:
ast (2.4.1)
kramdown (2.3.1)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.0.1)
kramdown (~> 2.0)
mini_portile2 (2.4.0)
mini_portile2 (2.8.0)
mustache (1.1.1)
mustermann (1.1.1)
ruby2_keywords (~> 0.0.1)
nokogiri (1.10.10)
mini_portile2 (~> 2.4.0)
nokogiri (1.13.8)
mini_portile2 (~> 2.8.0)
racc (~> 1.4)
parallel (1.20.1)
parser (2.7.2.0)
ast (~> 2.4.1)
power_assert (1.2.0)
racc (1.6.0)
rack (2.2.3)
rack-protection (2.1.0)
rack
Expand Down Expand Up @@ -59,9 +61,9 @@ PLATFORMS
ruby

DEPENDENCIES
nronn!
rack (~> 2.2, >= 2.2.3)
rake (~> 12.3, >= 12.3.3)
ronn-ng!
rubocop (~> 0.88, >= 0.88.0)
sinatra (~> 2.0, >= 2.0.8)
test-unit (~> 3.3, >= 3.3.6)
Expand Down
37 changes: 15 additions & 22 deletions INSTALLING.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,22 @@
Ronn-NG Installation
nRonn Installation
====================

## Installation Process

### From a Package Manager

The best way to install Ronn-NG is with a package manager. This is currently
only supported on macOS, with [Homebrew](http://brew.sh). To install with `brew`:

```
brew tap apjanke/ronn-ng
brew install ronn-ng
```

TBD
### From RubyGems

Ronn-NG is distributed as a gem package, which can be used if you don't have
nRonn is distributed as a gem package, which can be used if you don't have
a supported package manager. Install with rubygems:

```
gem install ronn-ng
gem install nronn
ronn --help
```

Ronn-NG includes completion definitions for bash and zsh, but these are not
nRonn includes completion definitions for bash and zsh, but these are not
installed into the system locations as part of the gem. You will need to figure
out how to install those into your system to make them available in your shell.

Expand All @@ -33,39 +26,39 @@ completion directories pointing at the files in the installed gem.
In Zsh, you can do something like this:

```
ronn_dist_dir=$(dirname $(dirname $(gem which ronn-ng)))
ronn_dist_dir=$(dirname $(dirname $(gem which nronn)))
ronn_zsh_dir="$ronn_dist_dir/completion/zsh"
ln -s "$ronn_zsh_dir/_ronn" /usr/local/share/zsh/site-functions
```

In Bash, something like this:

```
ronn_dist_dir=$(dirname $(dirname $(gem which ronn-ng)))
ronn_dist_dir=$(dirname $(dirname $(gem which nronn)))
ronn_bash_dir="$ronn_dist_dir/completion/bash"
ln -s "$ronn_bash_dir/ronn" /usr/local/etc/bash_completion.d
```

You will need to redo these steps each time you upgrade `ronn-ng` or install
You will need to redo these steps each time you upgrade `nronn` or install
it into a different Ruby environment. Sorry for the inconvenience; this seems
to be a limitation of the `gem` installation mechanism.

If that `gem which` stuff doesn't work for you, you can `gem install gem-path`
and use `gem path ronn-ng` instead.
and use `gem path nronn` instead.


## Building from Source

Hacking? Install Ronn-NG from source.
Hacking? Install nRonn from source.

Clone the git repository and put ronn/bin on your PATH:

```
git clone git://github.com/apjanke/ronn-ng
PATH=$(pwd)/ronn-ng/bin:$PATH
git clone git://github.com/apjanke/nronn
PATH=$(pwd)/nronn/bin:$PATH
```

The following gems are required for ronn-ng development:
The following gems are required for nronn development:
* nokogiri
* mustache
* kramdown
Expand All @@ -90,10 +83,10 @@ them be reflected in your active `ronn` command.

## Legacy Versions

Historical Ronn tarballs available at [the original Ronn repo](http://github.com/rtomayko/ronn/downloads).
Historical Ronn tarballs available at [the original Ronn repo](https://github.com/n-ronn/nronn/tags).

```
curl -L http://github.com/rtomayko/ronn/downloads/0.6.6 | tar xvzf -
curl -L https://github.com/n-ronn/nronn/archive/refs/tags/0.6.6.tar.gz | tar xvzf -
cd rtomayko-r*
ruby setup.rb
```
1 change: 1 addition & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ The MIT License

Copyright (C) 2009 Ryan Tomayko <tomayko.com/about>
Copyright (C) 2018, 2019 Andrew Janke <apjanke.net>
Copyright (C) 2022 Takuya Noguchi <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
41 changes: 13 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ronn-NG
# nRonn

Ronn-NG is a new, currently-maintained fork of the defunct [original Ronn
nRonn is a new, currently-maintained fork of the defunct [original Ronn
project](https://github.com/rtomayko/ronn).

Ronn builds manuals. It converts simple, human readable textfiles to roff for
Expand All @@ -15,30 +15,23 @@ The `*.ronn` files found in the [`man/`][1] directory show off a wide range of
ronn capabilities:

* [ronn(1)](http://rtomayko.github.com/ronn/ronn.1) command -
[source file](http://github.com/apjanke/ronn-ng/blob/master/man/ronn.1.ronn),
[roff output](http://github.com/apjanke/ronn-ng/blob/master/man/ronn.1)
[source file](https://github.com/n-ronn/nronn/blob/master/man/ronn.1.ronn),
[roff output](https://github.com/n-ronn/nronn/blob/master/man/ronn.1)

* [ronn-format(7)](http://rtomayko.github.com/ronn/ronn-format.7) -
[source file](http://github.com/apjanke/ronn-ng/blob/master/man/ronn-format.7.ronn),
[roff output](http://github.com/apjanke/ronn-ng/blob/master/man/ronn-format.7)
[source file](https://github.com/n-ronn/nronn/blob/master/man/ronn-format.7.ronn),
[roff output](https://github.com/n-ronn/nronn/blob/master/man/ronn-format.7)

[1]: http://github.com/apjanke/ronn-ng/tree/master/man
[1]: https://github.com/n-ronn/nronn/tree/master/man

As an alternative, you might want to check out [pandoc](http://johnmacfarlane.net/pandoc/) which can also convert markdown into roff manual pages.

## Installation

Install with Homebrew on macOS:

```bash
brew tap apjanke/ronn-ng
brew install ronn-ng
```

Install with `gem` anywhere that supports it:

```bash
gem install ronn-ng
gem install nronn
```

See [INSTALLING.md](INSTALLING.md) for details on other systems and installation methods.
Expand Down Expand Up @@ -83,7 +76,7 @@ comprehensive documentation on `ronn` command line options.

## Background

Some think Unix manual pages are a poor and outdated form of documentation. Ronn-NG
Some think Unix manual pages are a poor and outdated form of documentation. nRonn
disagrees:

* Manpages follow a well defined structure that's immediately familiar. This
Expand Down Expand Up @@ -120,27 +113,19 @@ modern publishing tools. Ronn aims to solve that problem.

## Requirements

Ruby 2.3 or newer, and gems as listed in `ronn-ng.gemspec`.
Ruby 2.3 or newer, and gems as listed in `nronn.gemspec`.

## Project Management

The project home page is at <https://github.com/apjanke/ronn-ng>. Bug reports,
The project home page is at <https://github.com/n-ronn/nronn>. Bug reports,
feature requests, and patch submissions are welcome.

Ronn-NG was forked from the original Ronn project in 2018 after Ronn
development had been defunct for a couple years, and Andrew wanted
some bugs fixed.

## License and Copying

MIT License.

Ronn is Copyright (C) 2010 [Ryan Tomayko](http://tomayko.com/about).

New Ronn-NG material is Copyright (C) 2018-2020 [Andrew Janke](https://apjanke.net).

See the file LICENSE.txt for information of licensing and distribution.
See [LICENSE.txt](LICENSE.txt) for detail.

## Build Status

![Travis build status](https://travis-ci.com/apjanke/ronn-ng.svg?branch=master)
TODO
12 changes: 6 additions & 6 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ desc 'Build the manual'
task man: :environment do
require 'ronn'
ENV['RONN_MANUAL'] = 'Ronn Manual'
ENV['RONN_ORGANIZATION'] = "Ronn-NG #{Ronn.revision}"
ENV['RONN_ORGANIZATION'] = "nRonn #{Ronn.revision}"
sh 'ronn -w -s toc -r5 --markdown man/*.ronn'
end

Expand Down Expand Up @@ -76,10 +76,10 @@ task :rev do
end

require 'rubygems'
@spec = eval(File.read('ronn-ng.gemspec'))
@spec = eval(File.read('nronn.gemspec'))

def package(ext = '')
"pkg/ronn-ng-#{@spec.version}" + ext
"pkg/nronn-#{@spec.version}" + ext
end

desc 'Build packages'
Expand All @@ -93,8 +93,8 @@ end
directory 'pkg/'
CLOBBER.include('pkg')

file package('.gem') => %w[pkg/ ronn-ng.gemspec] + @spec.files do |f|
sh 'gem build ronn-ng.gemspec'
file package('.gem') => %w[pkg/ nronn.gemspec] + @spec.files do |f|
sh 'gem build nronn.gemspec'
mv File.basename(f.name), f.name
end

Expand All @@ -109,7 +109,7 @@ def source_version
@source_version ||= `ruby -Ilib -rronn -e 'puts Ronn::VERSION'`.chomp
end

file 'ronn-ng.gemspec' => FileList['{lib,test,bin}/**', 'Rakefile'] do |f|
file 'nronn.gemspec' => FileList['{lib,test,bin}/**', 'Rakefile'] do |f|
# read spec file and split out manifest section
spec = File.read(f.name)
head, _manifest, tail = spec.split(" # = MANIFEST =\n")
Expand Down
6 changes: 3 additions & 3 deletions bin/ronn
Original file line number Diff line number Diff line change
Expand Up @@ -135,11 +135,11 @@ ARGV.options do |argv|
argv.on('-v', '--version') do
require 'ronn'
if Ronn.release?
printf "Ronn-NG v%s\n", Ronn::VERSION
printf "nRonn v%s\n", Ronn::VERSION
else
printf "Ronn-NG v%s (%s)\n", Ronn::VERSION, Ronn::REV
printf "nRonn v%s (%s)\n", Ronn::VERSION, Ronn::REV
end
printf "http://github.com/apjanke/ronn-ng/tree/%s\n", Ronn.revision
printf "https://github.com/n-ronn/nronn/tree/%s\n", Ronn.revision
exit 0
end
argv.on_tail('--help') { usage; exit 0 }
Expand Down
2 changes: 1 addition & 1 deletion completion/bash/ronn
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Bash completion script for ronn(1) from Ronn-NG
# Bash completion script for ronn(1) from nRonn

_ronn()
{
Expand Down
2 changes: 1 addition & 1 deletion completion/zsh/_ronn
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#compdef ronn

# Zsh completion definitions for ronn, from Ronn-NG
# Zsh completion definitions for ronn, from nRonn

_arguments -C -s -S \
'(--pipe)--pipe[write to standard output instead of generating files]' \
Expand Down
10 changes: 5 additions & 5 deletions doc-src/Developer-Guide.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Ronn-NG Developer's Guide
# nRonn Developer's Guide

## Release checklist

* Update the version in files
* ronn-ng.gemspec (update the release date, too)
* nronn.gemspec (update the release date, too)
* `lib/ronn.rb`
* Update `CHANGES` with the release date
* Regenerate the man pages with `bundle exec rake man`
Expand All @@ -13,14 +13,14 @@
* `git push --tags`
* Create the Release on GitHub Releases
* Build and deploy the gem to RubyGems
* `gem build ronn-ng.gemspec`
* `gem push ronn-ng-<version>.gem`
* `gem build nronn.gemspec`
* `gem push nronn-<version>.gem`
* TODO: Announce the release somewhere

After the release, start development on the next release:

* Update the version in files
* ronn-ng.gemspec
* nronn.gemspec
* `lib/ronn.rb`
* Update `CHANGES` with a new section for the next release
* Regenerate the man pages again: `rake man`
Expand Down
4 changes: 2 additions & 2 deletions lib/ronn/roff.rb
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ def previous(node)
end

def title_heading(name, section, _tagline, manual, version, date)
comment "generated with Ronn-NG/v#{Ronn.version}"
comment "http://github.com/apjanke/ronn-ng/tree/#{Ronn.revision}"
comment "generated with nRonn/v#{Ronn.version}"
comment "https://github.com/n-ronn/nronn/tree/#{Ronn.revision}"
return if name.nil?
if manual
macro 'TH', %("#{escape(name.upcase)}" "#{section}" "#{date.strftime('%B %Y')}" "#{version}" "#{manual}")
Expand Down
2 changes: 1 addition & 1 deletion lib/ronn/template.rb
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def page_name
end

def generator
"Ronn-NG/v#{Ronn.version} (http://github.com/apjanke/ronn-ng/tree/#{Ronn.revision})"
"nRonn/v#{Ronn.version} (https://github.com/n-ronn/nronn/tree/#{Ronn.revision})"
end

def manual
Expand Down
Loading

0 comments on commit 9b0427c

Please sign in to comment.