Documentation Issue - "Build the Code" section #1215

Closed
opened 2026-01-30 22:19:19 +00:00 by claunia · 4 comments
Owner

Originally created by @coderitual on GitHub (May 19, 2019).

/README.md needs to be updated to show correct path of build tools in Building the Code section. Following the current version of instruction the user will get

'bcz' is not recognized as an internal or external command, operable program or batch file.

Side note: after using bcz command from within tools folder it looks it is being added to the path for the current session.

Originally created by @coderitual on GitHub (May 19, 2019). `/README.md` needs to be updated to show correct path of build tools in `Building the Code` section. Following the current version of instruction the user will get ``` 'bcz' is not recognized as an internal or external command, operable program or batch file. ``` Side note: after using `bcz` command from within `tools` folder it looks it is being added to the path for the current session.
claunia added the Help WantedIssue-DocsProduct-MetaArea-Build labels 2026-01-30 22:19:19 +00:00
Author
Owner

@DHowett-MSFT commented on GitHub (May 19, 2019):

If you use .\tools\razzle from within CMD, bcz will be on your path.
If you use it from within PowerShell, don't do that. The razzle tool somewhat expects that it's been run from CMD.
There's a (somewhat underdocumented!) PowerShell module @adiviness maintains for building this code.

@DHowett-MSFT commented on GitHub (May 19, 2019): If you use `.\tools\razzle` from within CMD, `bcz` will be on your path. If you use it from within PowerShell, don't do that. The `razzle` tool somewhat expects that it's been run from CMD. There's a (somewhat underdocumented!) PowerShell module @adiviness maintains for building this code.
Author
Owner

@coderitual commented on GitHub (May 19, 2019):

Thanks @DHowett-MSFT ! Didn't know that. I have run both commands from within git-bash. What do you suggest to have this fixed? Maybe a simple comment that cmd.exe is recommended would work?

Do you want me to push this PR further and edit according to the comment I received from @oising ?

@coderitual commented on GitHub (May 19, 2019): Thanks @DHowett-MSFT ! Didn't know that. I have run both commands from within `git-bash`. What do you suggest to have this fixed? Maybe a simple comment that `cmd.exe` is recommended would work? Do you want me to push this PR further and edit according to the comment I received from @oising ?
Author
Owner

@zadjii-msft commented on GitHub (May 20, 2019):

Yea, I'd change the PR to simply mention that the commands should be called from cmd.exe.

@zadjii-msft commented on GitHub (May 20, 2019): Yea, I'd change the PR to simply mention that the commands should be called from `cmd.exe`.
Author
Owner

@coderitual commented on GitHub (May 20, 2019):

@zadjii-msft @DHowett-MSFT Done.

@coderitual commented on GitHub (May 20, 2019): @zadjii-msft @DHowett-MSFT Done.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#1215