(Ready for review) Improve start command on windows #316
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
Summary
This pull request introduces two changes to improve the project setup and usability:
Update
.gitignore
:/.history
to.gitignore
to prevent tracking IDE/editor-specific history files.Improve
start
Command for Cross-Platform Compatibility:start:windows
: Simplified command for running the project on Windows without requiring bindings.start:unix
: Existing start command for Unix-based systems with bindings.start
script to detect the operating system dynamically and execute the appropriate command.Motivation
On my channel I often get people complain of it not working on windows due to that
One example here: https://www.youtube.com/watch?v=-VkGI-cUaWw&lc=Ugy8rg_sGmOLSp7JoaN4AaABAg
Problem Addressed
The previous
start
command failed on Windows systems due to incompatible syntax for handling bindings. This issue required either manual adjustments or using a Linux subsystem, creating friction for Windows users.Solution
The updated
start
script dynamically detects the operating system:Changes
.gitignore
:/.history
to avoid unnecessary clutter from history files.package.json
:start:windows
andstart:unix
commands.start
command to dynamically detect the operating system and run the appropriate script.Testing
start
command runs successfully on both Windows and Unix-based systems.Impact