Skip to content

missing build instructions #3333

Closed
Closed

Description

@ChillerDragon

There is no INSTALL.md in the root of the repo and there are no instructions in the README.md. I had to find out by reading this comment how to build this project CppCXY/EmmyLuaCodeStyle#216 (comment)

Activity

  1. ChillerDragon commented on Jan 13, 2026

    @ChillerDragon
    Author

    Apparently there is also a make.sh script (which is missing the executable flag -.-). I guess there are multiple ways to build this. Imo the readme would benefit from advertising one official and tested way for each major platform on how to build it. Or at least mention a link to a documentation that does that.

  2. ChillerDragon commented on Jan 17, 2026

    @ChillerDragon
    Author

    I guess the wiki is linked in the readme and searching for "build" in the wiki leads to https://luals.github.io/wiki/build/

    So I am just too blind. Could be more visible but it is okayish I would say. The only other option would be duplicating a link to the wiki in the readme. Then the next person shows up and is looking for a different article in the wiki :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions