Skip to content

Conversation

PlayPGC
Copy link

@PlayPGC PlayPGC commented Aug 25, 2025

This PR improves the Getting Started documentation by clarifying the build step that should be run after yarn install.

Added a note about running yarn build after dependencies are installed

Helps new contributors avoid confusion when following setup instructions

Keeps documentation up-to-date with the actual project workflow

@PlayPGC PlayPGC requested a review from a team as a code owner August 25, 2025 12:00
@PlayPGC
Copy link
Author

PlayPGC commented Aug 25, 2025

@anton-trunov

Hi 👋, I made this small documentation update to clarify the build step after running yarn install.
Hope this helps new contributors avoid confusion.
Thanks for reviewing! 🙏

Copy link
Member

@novusnota novusnota left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, I don't think that this separate file is needed at all — we have a general audience-friendly section on top: https://github.com/tact-lang/tact#compiler.

And when it comes for contributors building Tact compiler, it's better to add couple of lines here: https://github.com/tact-lang/tact/blob/main/dev-docs/CONTRIBUTING.md#building-tact

Like, to add the following right after the heading and before the "The most up-to-date recipe to build..." line:

```shell
# Installs necessary dependencies
yarn install

# Runs the full build, preparing tests for future runs with yarn test
yarn build

# Simplified, sped-up build of the compiler only, without tests or miscellaneous extras
yarn build:fast
```

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