Skip to content

Update README.md#13

Merged
JaviLendi merged 3 commits into
mainfrom
VLMPy
Jul 13, 2025
Merged

Update README.md#13
JaviLendi merged 3 commits into
mainfrom
VLMPy

Conversation

@JaviLendi
Copy link
Copy Markdown
Owner

This pull request primarily updates the README.md file to enhance its structure, improve clarity, and provide more detailed information about the project. Additionally, it introduces new configuration variables in cache_plane_variables.txt and modifies the execution flow in src/vlm/app.py.

Documentation Improvements (README.md):

  • Expanded Table of Contents: Added new sections such as "Screenshots," "Usage," "Project Structure," and "Author," and reorganized installation steps for clarity.
  • Enhanced Features Section: Refined descriptions of features with clearer formatting and added details about visualization tools, documentation, and user interface.
  • Screenshots Section: Included visual examples of the application interface and outputs, along with a collapsible "View all screenshots" section.
  • Project Structure Overview: Added a detailed directory structure to help users navigate the codebase.
  • New Author Section: Introduced an "Author" section to highlight the creator's credentials and GitHub profile.

Configuration Updates (cache_plane_variables.txt):

  • New Plane Variables: Added detailed configuration for wing sections and horizontal stabilizers, including parameters like chord lengths, span fractions, sweep angles, and NACA profiles.

Code Execution Flow (src/vlm/app.py):

  • Modified Execution: Switched from running the app server to running the ui interface for the main application flow.This pull request updates the README.md to improve the documentation structure and content, adds new configuration variables in cache_plane_variables.txt, and modifies the application entry point in src/vlm/app.py. The changes aim to enhance usability, clarity, and functionality.

Documentation Updates (README.md):

  • Expanded Table of Contents: Added new sections like "Screenshots," "Usage," "Project Structure," and "Author" for better navigation. Updated installation instructions to include two options: Windows executable and source installation. [1] [2]
  • Improved Features Section: Revised descriptions with more detail and added new features like "User-Friendly Interface" and "Comprehensive Documentation."
  • Screenshots Section: Added visual examples of the application's interface and functionality, including a collapsible "View all screenshots" feature.
  • Usage and Project Structure: Detailed usage options (executable, Python API, Jupyter notebooks, web interface) and provided a directory structure overview for easier exploration.
  • Author and License: Added author details and license information for better attribution and compliance.

Configuration Updates (cache_plane_variables.txt):

  • New Variables: Added definitions for wing_sections and horizontal_stabilizer with detailed aerodynamic parameters like chord lengths, NACA profiles, and geometric properties.

Application Entry Point (src/vlm/app.py):

  • Switch to UI Mode: Changed the default execution mode from app.run to ui.run, indicating a shift from web-based interaction to a standalone user interface.

Expanded and reorganized the README with clearer installation, usage, and project structure sections, and added author and acknowledgements.
Replaces the JavaScript-based image gallery with a Markdown table and collapsible section for screenshots. This improves compatibility with GitHub's Markdown renderer and makes the gallery easier to maintain.
@JaviLendi JaviLendi merged commit 16d2b8a into main Jul 13, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant