docs: text improvements
refs #1897
Change-Id: Ic02a3764d5d597b82ed1adc564552016157ff07a
diff --git a/AUTHORS.md b/AUTHORS.md
index 95173ee..01b54bc 100644
--- a/AUTHORS.md
+++ b/AUTHORS.md
@@ -1,5 +1,5 @@
Shuo Chen <chenatu2006@gmail.com>
Alexander Afanasyev <http://lasr.cs.ucla.edu/afanasyev/index.html>
-Junxiao Shi <http://www.cs.arizona.edu/people/shijunxiao/>
+Junxiao Shi <https://www.cs.arizona.edu/~shijunxiao/>
Hang Zhang <http://netlab.bit.edu.cn/z_hang>
Weiqi Shi <swq11@mails.tsinghua.edu.cn>
diff --git a/INSTALL.md b/INSTALL.md
index dc94375..cc8fc6e 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -13,37 +13,37 @@
Build
-----
-To build in a terminal, change directory to the ndn_repo root. Enter:
+To build in a terminal, change directory to repo-ng repository. Enter:
./waf configure
./waf
sudo ./waf install
-This makes and installs the following items:
+This builds and installs `ndn-repo-ng` and related tools.
If configured with tests: `./waf configure --with-tests`), the above commands will
also generate unit tests in `./built/unit-tests`
-Config
-------
+Configuration
+-------------
-The default path of the configuration file is in `/usr/local/etc/ndn/repo-ng.conf`.
-
-The config file sample is repo-ng.conf.sample. Users should copy this file to the specific path and rename it to repo-ng.conf.
+The default configuration file path is `/usr/local/etc/ndn/repo-ng.conf`.
+Users may copy `repo-ng.conf.sample` config sample to the specific path.
Database
--------
-Users do not need to manually generate a database for repo since when a repo is running, it will generate a database by itself.
+The database path is set in "storage.path" key of the config file.
+The default database path is `/var/db/ndn-repo-ng`.
-The default database path is `/var/db/ndn-repo-ng`, which can be changed in repo-ng.conf "storage.path".
+`ndn-repo-ng` automatically creates a database if one does not exist.
-If the default database path is used, user should use root permission when running a repo.
+Users should make sure the `ndn-repo-ng` process has write privilege to the database path.
+If the default `/var/db/ndn-repo-ng` is used, repo-ng needs to be started with `sudo`.
Tools
-----
-Currently, three tools are supported : ndnputfile, ndngetfile and ndnrepowatch.
+Currently, three tools are supported: ndnputfile, ndngetfile, and ndnrepowatch.
-Users can find the detail information about these tool in http://redmine.named-data.net/projects/repo-ng/wiki/Tools.
-
+Users can find detailed information about these tools in <https://redmine.named-data.net/projects/repo-ng/wiki/Tools>.
diff --git a/README-dev.md b/README-dev.md
index 829db11..60dc71f 100644
--- a/README-dev.md
+++ b/README-dev.md
@@ -4,7 +4,7 @@
Code style
----------
-repo-ng code is subject to [ndn-cxx code style](http://named-data.net/doc/ndn-cxx/current/code-style.html).
+repo-ng code is subject to [ndn-cxx code style](https://named-data.net/doc/ndn-cxx/current/code-style.html).
Licensing
---------
@@ -15,7 +15,7 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
- * Copyright (c) 2014, Copyright Holder(s)
+ * Copyright (c) 2014-2017, Copyright Holder(s)
*
* This file is part of NDN repo-ng (Next generation of NDN repository).
* See AUTHORS.md for complete list of repo-ng authors and contributors.
diff --git a/README.md b/README.md
index e1444ed..cd3e92e 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,14 @@
repo-ng: Next generation of NDN repository
==========================================
-**repo-ng** is an implementation of a Named Data Networking data repository. The
-**repo-ng** follows Repo protocol of NDN. The specification of repo protocol is:
-
-* http://redmine.named-data.net/projects/repo-ng/wiki
+**repo-ng** is an implementation of a Named Data Networking data repository, and follows [Repo protocol](https://redmine.named-data.net/projects/repo-ng/wiki/Repo_Protocol_Specification).
**repo-ng** uses [ndn-cxx](https://github.com/named-data/ndn-cxx) library as NDN
development library, and uses sqlite3 as underlying storage.
**repo-ng** is an open source project licensed under GPL 3.0 (see `COPYING.md` for more
-detail). We highly welcome all contributions to the repo-ng code, provided that they can
-licensed under GPL 3.0+ or other compatible license.
+detail). We highly welcome all contributions to the repo-ng code, provided that they can licensed under GPL 3.0+ or other compatible license.
See the file `INSTALL.md` for build and install instructions.
-Please submit any bugs or issues to the **ndn-repo-ng** issue tracker:
-
-* http://redmine.named-data.net/projects/repo-ng/issues
+Please submit any bugs or issues to [repo-ng issue tracker](https://redmine.named-data.net/projects/repo-ng/issues).