Skip to content

Conversation

@tsvayer
Copy link

@tsvayer tsvayer commented Nov 3, 2024

The change updates the Readme for building with GNU Make directly from a repository root folder.

@farukeryilmaz
Copy link
Owner

Hi Vitaliy Tsvayer,

Thank you for the suggestion! Allowing users to build the project directly from the repository root adds convenience. My only concern is that, since the README already mentions that "Generated project files are under MyProject folder," it might be helpful to clarify both options to avoid any confusion.

Would you be open to updating the README in your pull request to include both options? Here’s a possible revision:

- For GNU Make:
  - Option 1: Navigate into the `MyProject` folder and run the following command:
    ```bash
    make config=release
    ```
  - Option 2: Build directly from the repository root using:
    ```bash
    make -C MyProject config=release
    ```

Additionally, I have a preference for commit messages written in the imperative mood (e.g., "add," "update," "fix"), as it treats each commit message as a directive to perform an action. This convention helps keep commit history clear and consistent. While I haven’t included this in the documentation yet, I’ll be adding a CONTRIBUTING.md file soon to outline contribution guidelines, including commit message conventions. For this update, a message like "update README to clarify GNU Make options" would be ideal for pull request title.

Thanks again for your attention to detail and for helping improve the project documentation!

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.

2 participants