Update README.md for improved clarity and formatting in setup instructions #120
Conversation
…tions Signed-off-by: Jesse Riemens <riemensjesse@gmail.com>
|
@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.
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.
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`. |
| ``` | ||
| 4. Navigate to your app directory and run: | ||
| ```sh | ||
| flutter run -run-qemu-master |
There was a problem hiding this comment.
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 |
2 participants
Modified the readme a bit to make the markdown-rendered formatting a bit more clear