README, CHANGELOG, and minor style fixes

4 files changed, 72 insertions, 35 deletions

diff --git a/.pylintrc b/.pylintrc
index 6b7f471..418a728 100644
--- a/.pylintrc
+++ b/.pylintrc
@@ -144,6 +144,19 @@ allow-wildcard-with-all=no
 logging-format-style=old
 
 
+[MESSAGES CONTROL]
+
+# disable similarities check
+disable=raw-checker-failed,
+        bad-inline-option,
+        locally-disabled,
+        file-ignored,
+        suppressed-message,
+        useless-suppression,
+        deprecated-pragma,
+        use-symbolic-message-instead,
+        duplicate-code
+
 
 [MISCELLANEOUS]
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e69de29..fb66c1e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -0,0 +1,28 @@
+
+# Changelog
+
+## 0.23.03 (Initial release)
+
+### Added
+
+- File graph protocol
+  - Graph access and navigation
+  - Syntactic sugar
+  - Fetch result shortcuts
+- Filter and Fetch Queries
+  - Syntax trees
+  - Validation
+  - Matching
+- Infrastructure to Open a storage
+- Storage schema
+- Backend
+  - Basic interface
+  - Sparql triple store: Manage triples via rdflib and sparql.
+- Access controls
+  - Basic interface
+  - NullAC: A dummy access control mechanism.
+- Essential utilities
+  - URI
+  - uuid
+  - namespaces
+
diff --git a/README.md b/README.md
index da066f6..1956752 100644
--- a/README.md
+++ b/README.md
@@ -1,57 +1,53 @@
 
-The Black Star File System
-==========================
+# The Black Star File System
 
+The Black Star File System (BSFS) is a semantic file system, meaning that it organizes files
+by association, and can record files, their metadata and content in a structured manner.
 
-### Developer tools setup
 
-#### Test coverage (coverage)
+## Installation
 
-Resources:
-* https://coverage.readthedocs.io/en/6.5.0/index.html
-* https://nedbatchelder.com/blog/200710/flaws_in_coverage_measurement.html
+You can install BSFS via pip:
 
-Commands:
-$ pip install coverage
-$ coverage run ; coverage html ; xdg-open .htmlcov/index.html
+    $ pip install --extra-index-url https://pip.bsfs.io bsfs
 
 
+## Development
 
-#### Static code analysis (pylint)
+Set up a virtual environment:
 
-Resources:
-* https://github.com/PyCQA/pylint
-* https://pylint.org/
-* https://pylint.pycqa.org/en/latest/user_guide/messages/messages_overview.html#messages-overview
+    $ virtualenv env
+    $ source env/bin/activate
 
-Commands:
-$ pip install pylint
-$ pylint bsfs
+Install bsfs as editable from the git repository:
 
+    $ git clone https://git.bsfs.io/bsfs.git
+    $ cd bsfs
+    $ pip install -e .
 
+Install the following additional packages besides bsfs:
 
-#### Type analysis (mypy)
+    $ pip install coverage mypy pylint
+    $ pip install sphinx sphinx-copybutton furo
+    $ pip install build
 
-Resources:
-* https://github.com/python/mypy
-* https://mypy.readthedocs.io/en/stable/
+To ensure code style discipline, run the following commands:
 
-Commands:
-$ pip install mypy
-$ mypy
+    $ coverage run ; coverage html ; xdg-open .htmlcov/index.html
+    $ pylint bsfs
+    $ mypy
 
+To build the package, do:
 
+    $ python -m build
 
-#### Documentation (sphinx)
-
-Resources:
-* 
-* 
-
-Commands:
-$ pip install ...
-$ 
+To run only the tests (without coverage), run the following command from the **test folder**:
 
+    $ python -m unittest
 
+To build the documentation, run the following commands from the **doc folder**:
 
+    $ sphinx-apidoc -f -o source/api ../bsfs/ --module-first -d 1 --separate
+    $ make html
+    $ xdg-open build/html/index.html
 
diff --git a/bsfs/apps/__init__.py b/bsfs/apps/__init__.py
index 3dec9ad..a85d5db 100644
--- a/bsfs/apps/__init__.py
+++ b/bsfs/apps/__init__.py
@@ -37,7 +37,7 @@ def main(argv=None):
     parser = argparse.ArgumentParser(description=main.__doc__, prog='bsfs')
     # version
     parser.add_argument('--version', action='version',
-        version='%(prog)s version {}.{}.{}'.format(*bsfs.version_info))
+        version='%(prog)s version {}.{}.{}'.format(*bsfs.version_info)) # pylint: disable=C0209
     # application selection
     parser.add_argument('app', choices=apps.keys(),
         help='Select the application to run.')