summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Peveler <matt.peveler@gmail.com>2020-06-05 00:25:40 -0400
committerMatthew Peveler <matt.peveler@gmail.com>2021-01-28 02:37:55 +0000
commite4fae7cbf68cd5403d63a2b5c9a76da5a8be2199 (patch)
tree4985e0e1def376e0a7b5f06a3986a8adc525d323
parentb13131d4564e26c77d3ffd9d585145acafd38021 (diff)
downloadasciidoc-py3-e4fae7cbf68cd5403d63a2b5c9a76da5a8be2199.tar.gz
update README to markdown to use within pypi
Signed-off-by: Matthew Peveler <matt.peveler@gmail.com>
-rw-r--r--README.md48
-rw-r--r--build_website.sh1
-rw-r--r--setup.py2
-rw-r--r--website/README.txt (renamed from README.asciidoc)0
4 files changed, 49 insertions, 2 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..388935c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+AsciiDoc
+========
+
+[![Build Status](https://travis-ci.com/asciidoc/asciidoc-py3.svg?branch=master)](https://travis-ci.com/asciidoc/asciidoc-py3)
+
+AsciiDoc is a text document format for writing notes, documentation,
+articles, books, ebooks, slideshows, web pages, man pages and blogs.
+AsciiDoc files can be translated to many formats including HTML, PDF,
+EPUB, man page.
+
+AsciiDoc is highly configurable: both the AsciiDoc source file syntax
+and the backend output markups (which can be almost any type of
+SGML/XML markup) can be customized and extended by the user.
+
+## Prerequisites
+
+AsciiDoc is written in Python so you need a Python interpreter
+(version 3.5 or later) to execute asciidoc(1). Python is installed by
+default in most Linux distributions. You can download Python from the
+official Python website http://www.python.org.
+
+## Obtaining AsciiDoc
+
+AsciiDoc's Python 3 port is currently under development. To obtain AsciiDoc,
+download a copy of the repo from the GitHub project at
+https://github.com/asciidoc/asciidoc-py3 and follow the instructions in
+INSTALL.txt to build and install it.
+
+## Tools
+
+Current AsciiDoc version tested on Ubuntu 18.04 with:
+
+- Python 3.6.5
+- DocBook XSL Stylesheets 1.76.1
+- xsltproc (libxml 20706, libxslt 10126 and libexslt 815).
+- w3m 0.5.2
+- dblatex 0.3
+- FOP 0.95
+- A-A-P 1.091
+
+
+## Copying
+
+Copyright (C) 2002-2013 Stuart Rackham.
+Copyright (C) 2013-2020 AsciiDoc Contributors.
+
+Free use of this software is granted under the terms of the GNU General
+Public License version 2 (GPLv2).
diff --git a/build_website.sh b/build_website.sh
index 2ee1775..79dd0ee 100644
--- a/build_website.sh
+++ b/build_website.sh
@@ -52,7 +52,6 @@ for file in ${files[@]}; do
done
set -x
-cp README.asciidoc gh-pages/README.txt
cp website/* gh-pages
cp doc/*.txt gh-pages
cp -R images gh-pages
diff --git a/setup.py b/setup.py
index 2f053c6..351c7d5 100644
--- a/setup.py
+++ b/setup.py
@@ -69,7 +69,7 @@ setup(
name=NAME,
version=about['__version__'],
description=DESCRIPTION,
- long_description=open(os.path.join(here, 'README')),
+ long_description=open(os.path.join(here, 'README.md')).read(),
long_description_content_type='text/markdown', # This is important!
author=AUTHOR,
python_requires=REQUIRES_PYTHON,
diff --git a/README.asciidoc b/website/README.txt
index 7a5f89c..7a5f89c 100644
--- a/README.asciidoc
+++ b/website/README.txt