update to version 0.1.0

1. changelog.md updated
2. icon for extension added
3. Roadmap info added in readme.md

Author: liqunkang

CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to the "orcatoc" extension will be documented in this file.
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
-## [Unreleased]
+## [0.0.1] - 2023-10-09
 
-- Initial release
+- Initial release of orcatoc. This is a very early release and is still under development.
+
+## [0.0.2] - 2023-10-11
+
+- Added support for automatically showing TOC view when opening an ORCA output file.
+
+- `headings.md` file added to the extension. This file contains a list of regular expressions that are used to parse the ORCA output file. The list of regular expressions will be updated in future releases.
+
+- `generate_patterns.py` script added to the extension. This script is used to parse the `headings.md` file and generate the `patterns.json` file. The `patterns.json` file is used by the extension to parse the ORCA output file.
+
+## [0.1.0] - 2023-10-14
+
+- Update of `patterns.json` file and `headings.md` file. Additional regular expressions added to the list used to parse the ORCA output file. Most frequently used keywords in the ORCA output file are now parsed. The list of regular expressions will be updated in future releases.

README.md

@@ -12,7 +12,7 @@ N/A
 
 ## Extension Settings
 
-The current version (0.0.2) of this extension does not have any settings.
+The current version (0.1.0) of this extension does not have any settings.
 
 ## Known Issues
 
@@ -38,7 +38,11 @@ Added support for automatically showing TOC view when opening an ORCA output fil
 
 ---
 
-## Roadmap
+### 0.1.0
+
+Update of `patterns.json` file and `headings.md` file. Additional regular expressions added to the list used to parse the ORCA output file. Most frequently used keywords in the ORCA output file are now parsed. The list of regular expressions will be updated in future releases.
+
+## TODO
 
 - [x] Automatically show TOC view when opening an ORCA output file
 - [ ] Automatically update TOC view when saving changes to an ORCA output file (additional command to manually refresh TOC view)
@@ -48,6 +52,14 @@ Added support for automatically showing TOC view when opening an ORCA output fil
 - [ ] Add icon to this extension
 - [x] Updating the list of regular expressions used to parse the ORCA output file
 
+## Roadmap
+
+The current version represents a very early release of this extension. 
+
+The list of regular expressions in the `headings.md` file is parsed by converting each heading and the corresponding regular expression into a JSON object. The headings that will be displayed in the `ORCA FILE OUTLINE` is the heading text. This approach is not very flexible because some of the headings in the ORCA output file could be changed based on the type of calculation or in different versions of ORCA. In the next major release, the list of regular expressions will be more universal and the matched text will be displayed in the `ORCA FILE OUTLINE` view. The list of regular expressions will be updated in future releases. Most of the keywords in the ORCA output file are in full capital letters, which is not very user friendly. In the next major release, the matched text will be converted to title case before being displayed in the `ORCA FILE OUTLINE` view. There will be a list of keywords that will not be converted to title case. The list of keywords will be updated in future releases.
+
+Another feature that will be added in the next major release is to enable the scrolling of the `ORCA FILE OUTLINE` view to the current line in the ORCA output file. This will be useful when the ORCA output file is very long and the user is navigating through the file. The `ORCA FILE OUTLINE` view will automatically scroll to the current line in the ORCA output file.
+
 ## For Developers
 
 The list of regular expressions is saved in `patterns.json` file. The file contains a list of regular expressions that are used to parse the ORCA output file. Each regular expression is a JSON object with the following properties:

images/orca_TOC.png

@@ -2,7 +2,7 @@
   "name": "orcatoc",
   "displayName": "orca_toc",
   "description": "Provides an outline for ORCA files in the VS Code sidebar.",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "engines": {
     "vscode": "^1.82.0"
   },
@@ -58,5 +58,6 @@
     "url": "https://github.com/liqunkang/orca_TOC.git" 
   },
   "license": "GPL-3.0",
-  "publisher": "liqunKang"
+  "publisher": "liqunKang",
+  "icon": "images/orca_TOC.png"
 }