summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 31 insertions, 18 deletions
diff --git a/README.md b/README.md
index 05e1f0c..b0305b9 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,4 @@
-|Branch|CI system|Status|
-|:----:|:-------:|-----:|
-|Master|Gitlab|[![build status](https://gitlab.com/gnutls/libtasn1/badges/master/build.svg)](https://gitlab.com/gnutls/libtasn1/commits/master)[![coverage report](https://gitlab.com/gnutls/libtasn1/badges/master/coverage.svg)](https://gnutls.gitlab.io/libtasn1/coverage)|
-
-# libtasn1
+# Libtasn1 README -- Introduction information
This is GNU Libtasn1, a small ASN.1 library.
@@ -36,11 +32,20 @@ The required software is typically distributed with your operating
system, and the instructions for installing them differ. Here are
some hints:
-gNewSense/Debian/Ubuntu:
+Debian/Ubuntu:
+```
+sudo apt-get install make git autoconf automake libtool bison
+sudo apt-get install texinfo help2man gtk-doc-tools valgrind abigail-tools
+```
+
+PDF manual - Debian <= stretch:
+```
+sudo apt-get install texlive-generic-recommended texlive texlive-extra-utils
+```
+
+PDF manual - Debian >= buster:
```
-sudo apt-get install make git-core autoconf automake libtool
-sudo apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils
-sudo apt-get install help2man gtk-doc-tools valgrind abigail-tools
+sudo apt-get install texlive-plain-generic texlive texlive-extra-utils
```
The next step is to run autoreconf, ./configure, etc:
@@ -52,7 +57,7 @@ $ ./bootstrap
Then build the project normally:
```
-$ make
+$ ./configure
$ make check
```
@@ -61,10 +66,16 @@ Happy hacking!
## Manual
-The manual is in the `doc/` directory of the release. You can also browse
-the manual online at:
+The manual is in the `doc/` directory of the release.
- - https://gnutls.gitlab.io/libtasn1/
+You can also browse the manual online at:
+
+ - https://www.gnu.org/software/libtasn1/manual/
+ - https://gnutls.gitlab.io/libtasn1/manual/
+ - https://gnutls.gitlab.io/libtasn1/manual/libtasn1.html
+ - https://gnutls.gitlab.io/libtasn1/manual/libtasn1.pdf
+ - https://gnutls.gitlab.io/libtasn1/reference/
+ - https://gnutls.gitlab.io/libtasn1/reference/libtasn1.pdf
## Code coverage report
@@ -74,12 +85,14 @@ The coverage report is at:
- https://gnutls.gitlab.io/libtasn1/coverage
-## Homepage
+## Issue trackers
-The project homepage at the gnu site is at:
+ - [Main issue tracker](https://gitlab.com/gnutls/libtasn1/issues)
+ - [oss-fuzz found issues](https://bugs.chromium.org/p/oss-fuzz/issues/list?q=libtasn1&can=2)
-http://www.gnu.org/software/libtasn1/
+## Homepage
+
+The project homepage at the gnu site is at:
-For any copyright year range specified as YYYY-ZZZZ in this package
-note that the range specifies every single year in that closed interval.
+https://www.gnu.org/software/libtasn1/