8000 Improve installation and demo package documentation (#818) by viradiyashivali-cmd · Pull Request #856 · esmini/esmini · GitHub
[go: up one dir, main page]

Skip to content

Improve installation and demo package documentation (#818) - #856

Open
viradiyashivali-cmd wants to merge 1 commit into
esmini:devfrom
viradiyashivali-cmd:improve-installation-docs
Open

viradiyashivali-cmd wants to merge 1 commit into
esmini:devfrom
viradiyashivali-cmd:improve-installation-docs

Conversation

@viradiyashivali-cmd
@viradiyashivali-cmd viradiyashivali-cmd commented Nov 17, 2026 •
Copy link
Copy Markdown

Resolves #818

Summary of Changes

This PR improves the installation and getting started documentation based on user feedback in #818:

  1. Clarify demo package extraction folder:

    • The demo package extracts to a folder named esmini-demo (not esmini). Updated docs/user_guide/getting-started.adoc, README.md, and docs/user_guide/scenario-construction-tips.adoc to reference esmini-demo and esmini-demo/run/esmini.
    • Updated package naming examples to match current release assets (esmini-demo_Windows.zip, esmini-demo_Linux.zip, esmini-demo_macOS.zip).
  2. Clarify instructions for getting complete esmini:

    • Added explicit instructions for downloading release source archives (esmini-fullsrc.zip or the source code archive from releases) as an alternative to git clone to guarantee version alignment with pre-built binaries and assist users not using Git.
    • Updated binary package names (esmini-bin_Windows.zip, esmini-bin_Linux.zip, esmini-bin_macOS.zip instead of outdated esmini-bin_win_x64.zip).
    • Fixed destination path: clarified that binary package contents are unpacked/copied into the repository root folder esmini (populating esmini/bin and esmini/EnvironmentSimulator) rather than esmini-demo.
    • Clarified 3D model unpacking path into esmini/resources (creating esmini/resources/models).
    • Updated the 3D model download link in README.md to match the current model package (models_with_lights.7z).

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

0