Update docs. Add changelog

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Achieved Feature parity with parser implementation in [dalance/svlint](https://github.com/dalance/svlint/)
+- Parse files, include directories and defines
+- Support environment variables

README.md

@@ -1,7 +1,11 @@
 # Verilog Filelist Parser
 
 A library in Rust to parse a Verilog Filelist and return
-a list of files, include directories and defines
+a list of files, include directories and defines.
+
+Environment variables represented with paranthesis or 
+curly braces (i.e. $() or ${}) will be automatically
+substituted.
 
 # Example
 ```rust

src/file_parser.rs

@@ -44,11 +44,14 @@ impl Filelist {
     }
 }
 
-/// Parses a filelist file
+/// Parses a filelist file.
-///
+/// 
+/// Environment variables represented with paranthesis or 
+/// curly braces (i.e. `$()` or `${}`) will be automatically
+/// substituted.
 /// # Arguments
 ///
-/// * `path` - A string slice that is the path to the filelist file
+/// * `path` - A string slice that is the path to the filelist
 ///
 /// # Errors
 ///

src/lib.rs

@@ -1,7 +1,11 @@
 //! # Verilog Filelist Parser
 //! 
 //! A library to parse a Verilog Filelist and return
-//! a list of files, include directories and defines
+//! a list of files, include directories and defines.
+//! 
+//! Environment variables represented with paranthesis or 
+//! curly braces (i.e. `$()` or `${}`) will be automatically
+//! substituted.
 //! 
 //! # Example
 //! ```