Add CHANGELOG.md

CHANGELOG.md

@@ -1,10 +1,13 @@
+Changelog
+=========
+
 Version 3.10.0
 --------------
 
 1. **Python**
    - Code refactoring for better code management and efficiency: moved main
      logic in `litrepl` from `python/bin/litrepl` to a new file
-     `python/litrepl/main.py`, focusing on cleaner separation of concerns.
+     [python/litrepl/main.py](./python/litrepl/main.py).
    - Improved handling of subprocess management for the Python and AI
      interpreters, ensuring proper cleanup and output management. Additionally,
      calls to `os.system` were mostly replaced with native Python calls.
@@ -19,15 +22,17 @@ Version 3.10.0
    - Updated commands related to AI tasks like `:LAIStyle`, `:LAIFile`, and
      `:LAICode` to handle rephrasing and AI interaction more efficiently.
    - Adjusted internal Vim functions to handle text width settings and cursor
-     positionings more accurately.
+     positionings.
 
 3. **Environment**
-   - Replaced `test.sh` with `runtests.sh` in the build and test process for
-     enhanced test execution flow.
+   - Replaced `test.sh` with [runtests.sh](./sh/runtests.sh) in the build and test
+     process for enhanced test execution flow.
    - Allowed more environment configuration by introducing more settings that
      default from environment variables, streamlining setup customization.
-   - Updated Nix build script (`default.nix`) to reflect changes in the test
-     script location and hash updates for source verification.
+   - Updated Nix build script ([default.nix](./default.nix)) to reflect changes
+     in the test script location and hash updates for source verification.
+   - Added this changelog and the AI-powered changelog helper script
+     [diffchanges.sh](./sh/diffchanges.sh).
 
 Version 3.9.0
 -------------
@@ -37,21 +42,22 @@ Version 3.9.0
      enhancing error handling robustness.
 
 2. **Vim**
-   - Enhanced `vim/plugin/litrepl.vim` by preserving caret positions and
-     restructuring comments for function alignment.
-   - Significant expansions in `vim/plugin/litrepl_extras.vim` with multiple new
-     functions for region handling, AI task management, and interaction across
-     different scopes, substantially improving user experience with AI
-     functionalities in Vim. Several new commands such as `LAITell`, `LAICont`,
-     `LAIStyle`, `LAIFile`, and `LAICode` are introduced to support a wide range
-     of code and AI-related tasks.
+   - Enhanced [vim/plugin/litrepl.vim](./vim/plugin/litrepl.vim) by preserving
+     caret positions and restructuring comments for function alignment.
+   - Significant expansions in
+     [vim/plugin/litrepl_extras.vim](./vim/plugin/litrepl_extras.vim) with
+     multiple new functions for region handling, AI task management, and
+     interaction across different scopes, substantially improving user
+     experience with AI functionalities in Vim. Several new commands such as
+     `LAITell`, `LAICont`, `LAIStyle`, `LAIFile`, and `LAICode` are introduced
+     to support a wide range of code and AI-related tasks.
 
 3. **Environment**
-   - Added a new markdown file `doc/screencast.md` with examples for evaluating
-     Python code in Vim, offering insights into the screencast documentation
-     process.
+   - Added a new markdown file `./doc/screencast.md` with examples for
+     evaluating Python code in Vim, offering insights into the screencast
+     documentation process.
    - Adjusted `screencast.sh` to be executable and made improvements to
-     accommodate a target file parameter `$T`.
+     accommodate a target file parameter.
    - Introduced a new test function `test_vim_ai_query` in `test.sh`,
      facilitating new test coverage for AI query functionality.
 

setup.py

@@ -3,6 +3,7 @@
 from os import environ
 from logging import getLogger
 from typing import Optional
+from textwrap import dedent
 logger=getLogger(__name__)
 warning=logger.warning
 
@@ -39,8 +40,15 @@
     f.write("# AUTOGENERATED by setup.exe!\n")
     f.write(f"__semver__ = '{LITREPL_SEMVER}'\n")
 
+with open("CHANGELOG.md", "r") as f:
+  changelog = f.read()
 with open("README.md", "r") as f:
-  long_description = f.read()
+  readme = f.read()
+
+long_description = dedent(f'''
+{changelog}
+{readme}
+''')
 
 setup(
   name="litrepl",