summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 14 insertions, 11 deletions
diff --git a/README.md b/README.md
index 388935c..50c26b2 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,10 @@
AsciiDoc
========
-[![Build Status](https://travis-ci.com/asciidoc/asciidoc-py3.svg?branch=master)](https://travis-ci.com/asciidoc/asciidoc-py3)
+[![Build Status](https://github.com/asciidoc/asciidoc-py3/workflows/Test/badge.svg?branch=master)](https://github.com/asciidoc/asciidoc-py3/actions?query=workflow%3ATest+branch%3Amaster)
+
+__This branch is tracking the alpha, in-progress 10.x release. For the stable 9.x code,
+please go to the [9.x branch](https://github.com/asciidoc/asciidoc-py3/tree/9.x)!__
AsciiDoc is a text document format for writing notes, documentation,
articles, books, ebooks, slideshows, web pages, man pages and blogs.
@@ -15,16 +18,18 @@ 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.
+(version 3.5 or later) to execute asciidoc(1). You can install Python using the
+package manager for your OS or by downloading it 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.
+Documentation and installation instructions are on the AsciiDoc website
+http://asciidoc.org/. Additionally, for 10.x, you can install it using pip:
+
+```
+pip3 install asciidoc
+```
## Tools
@@ -36,13 +41,11 @@ Current AsciiDoc version tested on Ubuntu 18.04 with:
- 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.
+Copyright (C) 2013-2021 AsciiDoc Contributors.
Free use of this software is granted under the terms of the GNU General
Public License version 2 (GPLv2).