-
Notifications
You must be signed in to change notification settings - Fork 12
Update README.md for improved clarity and formatting in setup instructions #120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: v2.0
Are you sure you want to change the base?
Conversation
…tions Signed-off-by: Jesse Riemens <[email protected]>
@JesseRiemens What environment(s) are you working with? |
Currently developing on Ubuntu 24.04 @ x86_64 compiling for arm64 (embedded target) & x86_64 (embedded target and desktop target) |
@JesseRiemens anything with Windows? I see you have modified the Windows section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request improves the README.md file by enhancing markdown formatting and organization for better readability. The changes focus on restructuring setup instructions with proper headers, code blocks, and clearer navigation.
Key Changes
- Reorganized content with proper hierarchical headers and formatting
- Added code blocks with syntax highlighting for better command visibility
- Improved structure with horizontal dividers and consistent formatting
- **For ARM64 Windows machines:** | ||
- Copy `C:\Program Files (x86)\Windows Kits\10\Debuggers\arm64` to `C:\Program Files (x86)\Windows Kits\10\Debuggers\arm64` to appease `flutter/tools/gen.bat`. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The copy instruction specifies the same source and destination path. This appears to be a copy-paste error and the instruction is meaningless as written.
- **For ARM64 Windows machines:** | |
- Copy `C:\Program Files (x86)\Windows Kits\10\Debuggers\arm64` to `C:\Program Files (x86)\Windows Kits\10\Debuggers\arm64` to appease `flutter/tools/gen.bat`. | |
- **For ARM64 Windows machines:** | |
- Copy `C:\Program Files (x86)\Windows Kits\10\Debuggers\arm64` to `C:\path\to\desired\destination` to appease `flutter/tools/gen.bat`. |
Copilot uses AI. Check for mistakes.
``` | ||
4. Navigate to your app directory and run: | ||
```sh | ||
flutter run -run-qemu-master |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The command flutter run -run-qemu-master
appears to have an incorrect flag format. Flutter commands typically use double dashes for flags (e.g., --device
or custom device names), not single dashes for multi-word options.
flutter run -run-qemu-master | |
flutter run --run-qemu-master |
Copilot uses AI. Check for mistakes.
Modified the readme a bit to make the markdown-rendered formatting a bit more clear