build: switch source archive to xz compression

And a few minor README improvements

Change-Id: I667860f46b19d1ec885fd81910a116581007ac8f

.github/workflows/ci.yml

@@ -3,7 +3,7 @@ on:
   push:
     paths-ignore:
       - 'docs/**'
-      - '*.conf.sample'
+      - '*.conf.sample*'
       - '*.md'
       - '.mailmap'
   workflow_dispatch:

AUTHORS.md

@@ -2,7 +2,7 @@
 
 The following lists maintainers, primary developers, and all much-appreciated contributors to ndn-cxx in alphabetical order.
 The specific contributions of individual authors can be obtained from the git history of the [official ndn-cxx repository](https://github.com/named-data/ndn-cxx).
-If you would like to become a contributor to the official repository, please follow the recommendations in <https://github.com/named-data/.github/blob/master/CONTRIBUTING.md>.
+If you would like to become a contributor to the official repository, please follow the recommendations in <https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>.
 
 * Sepehr Abdous <https://sepehrabdous.github.io>
 * ***(Maintainer)*** Alexander Afanasyev <https://users.cs.fiu.edu/~afanasyev>

README-dev.md

@@ -1,8 +1,8 @@
 Notes for ndn-cxx developers
 ============================
 
-If you are new to the NDN community of software generally, read the
+If you are new to the NDN software community, please read our
-[Contributor's Guide](https://github.com/named-data/.github/blob/master/CONTRIBUTING.md).
+[Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md).
 
 Code style
 ----------
@@ -12,9 +12,9 @@ ndn-cxx code is subject to [ndn-cxx code style](https://named-data.net/doc/ndn-c
 Licensing
 ---------
 
-Contributions to the library must be licensed under the LGPL v3 or compatible license.  If
+Contributions to ndn-cxx must be licensed under the LGPL v3 or a compatible license.
-you are choosing LGPL v3, please use the following license boilerplate in all `.hpp` and
+If you choose the LGPL v3, please use the following license boilerplate in all `.hpp`
-`.cpp` files:
+and `.cpp` files:
 
     /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
     /*
@@ -35,11 +35,6 @@ you are choosing LGPL v3, please use the following license boilerplate in all `.
      * <http://www.gnu.org/licenses/>.
      *
      * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
-     ////// [optional part] //////
-     *
-     * @author Author's Name <email@domain-or-homepage://url>
-     * @author Other Author's Name <another.email@domain-or-homepage://url>
-     ////// [end of optional part] //////
      */
 
 If you are affiliated to an NSF-supported NDN project institution, please use the [NDN Team License

README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-[<img alt height="70" src="docs/named_data_theme/static/ndn-logo.svg"/>](https://named-data.net/)
+[<img alt height="65" src="docs/named_data_theme/static/ndn-logo.svg"/>](https://named-data.net/)
 
 # ndn-cxx: NDN C++ library with eXperimental eXtensions
 
@@ -30,21 +30,22 @@ used by the following projects:
 
 See [`docs/INSTALL.rst`](docs/INSTALL.rst) for compilation and installation instructions.
 
-Extensive documentation is available on the library's [homepage](https://named-data.net/doc/ndn-cxx/).
+Extensive documentation is available on the library's [homepage](https://docs.named-data.net/ndn-cxx/).
 
 ## Reporting bugs
 
-Please submit any bugs or feature requests to the
+Please submit any bug reports or feature requests to the
 [ndn-cxx issue tracker](https://redmine.named-data.net/projects/ndn-cxx/issues).
 
 ## Contributing
 
-We greatly appreciate contributions to the ndn-cxx code base.
+Contributions to ndn-cxx are greatly appreciated and can be made through our
-If you are new to the NDN software community, please read the
+[Gerrit code review site](https://gerrit.named-data.net/).
-[Contributor's Guide](https://github.com/named-data/.github/blob/master/CONTRIBUTING.md)
+If you are new to the NDN software community, please read our
-to get started.
+[Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md)
+and [`README-dev.md`](README-dev.md) to get started.
 
 ## License
 
-ndn-cxx is an open source project licensed under the LGPL version 3.
+ndn-cxx is free software distributed under the GNU Lesser General Public License version 3.
-See [`COPYING.md`](COPYING.md) for more information.
+See [`COPYING.md`](COPYING.md) for details.

docs/index.rst

@@ -51,7 +51,7 @@ Documentation
 For developers
 ^^^^^^^^^^^^^^
 
-- `NDN Software Contributor's Guide <https://github.com/named-data/.github/blob/master/CONTRIBUTING.md>`__
+- `NDN Software Contributor's Guide <https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>`__
   (guide for newcomers to the NDN community of software)
 
 - :doc:`specs`

wscript

@@ -400,7 +400,9 @@ def version(ctx):
         Logs.warn('%s is not writable (%s)' % (versionFile, e.strerror))
 
 def dist(ctx):
+    ctx.algo = 'tar.xz'
     version(ctx)
 
 def distcheck(ctx):
+    ctx.algo = 'tar.xz'
     version(ctx)