diff options
| author | Matthew Peveler <matt.peveler@gmail.com> | 2021-01-29 15:26:13 +0000 |
|---|---|---|
| committer | Matthew Peveler <matt.peveler@gmail.com> | 2021-01-29 15:26:13 +0000 |
| commit | c4c6c5402d3028e750bf589a01aab57a3cf2fc18 (patch) | |
| tree | 30fecbfc59ecb46b96c9b3f84f63e1e99793678b | |
| parent | bfc6187589095f11fbee08624e5b16aeddbeecdc (diff) | |
| download | asciidoc-py3-c4c6c5402d3028e750bf589a01aab57a3cf2fc18.tar.gz | |
update README to indicate branch status
Signed-off-by: Matthew Peveler <matt.peveler@gmail.com>
| -rw-r--r-- | README.md | 25 |
1 files changed, 14 insertions, 11 deletions
@@ -1,7 +1,10 @@ AsciiDoc ======== -[](https://travis-ci.com/asciidoc/asciidoc-py3) +[](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). |