Option (or default) to open readme.md

[valhuber]

My project creates projects for others, including a readme for instructions/getting started. I would like this to auto-open, either by default, or by an option in settings or workspace. I think this is a generally useful feature, which I have seen provided in other IDEs.

[gjsjohnmurray]

I suggest you try this user-level setting

"workbench.startupEditor" : "readme"

[valhuber]

For my use case, it needs to be part of the project/workspace.

I created it as a workspace, with created.code-workspace as:

{ "folders": [ { "path": ".." } ], "settings": { "workbench.startupEditor" : "readme", "debug.console.wordWrap": false, "workbench.editorAssociations": { "*.md": "vscode.markdown.preview.editor" }, "workbench.colorTheme": "Arduino", "workbench.preferredLightColorTheme": "Arduino" } }

But did not open the readme.



On Jun 29, 2024, at 9:06 PM, John Murray @.***> wrote:

I suggest you try this user-level setting

"workbench.startupEditor" : "readme"

— Reply to this email directly, view it on GitHub https://github.com/microsoft/vscode/issues/219279#issuecomment-2198425542, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABKSG343R6RB2PBE6IZHDALZJ573LAVCNFSM6AAAAABKDTPIY2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCOJYGQZDKNJUGI. You are receiving this because you authored the thread.

[valhuber]

And it appears to unsupported in workspaces… sadly…

https://github.com/microsoft/vscode/issues/124689 Setting workbench.startupEditor=readme|newUntitledFile doesn't work in Workspace Settings · Issue #124689 · microsoft/vscode github.com

On Jun 29, 2024, at 9:37 PM, Val Huber @.***> wrote:

For my use case, it needs to be part of the project/workspace.

I created it as a workspace, with created.code-workspace as:

{ "folders": [ { "path": ".." } ], "settings": { "workbench.startupEditor" : "readme", "debug.console.wordWrap": false, "workbench.editorAssociations": { "*.md": "vscode.markdown.preview.editor" }, "workbench.colorTheme": "Arduino", "workbench.preferredLightColorTheme": "Arduino" } }

But did not open the readme.

<Screenshot 2024-06-29 at 9.37.04 PM.png>

On Jun 29, 2024, at 9:06 PM, John Murray @.***> wrote:

I suggest you try this user-level setting

"workbench.startupEditor" : "readme"

— Reply to this email directly, view it on GitHub https://github.com/microsoft/vscode/issues/219279#issuecomment-2198425542, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABKSG343R6RB2PBE6IZHDALZJ573LAVCNFSM6AAAAABKDTPIY2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCOJYGQZDKNJUGI. You are receiving this because you authored the thread.

[gjsjohnmurray]

Maybe it should be permitted for trusted workspaces.

[vscodenpa]

This feature request is now a candidate for our backlog. The community has 60 days to upvote the issue. If it receives 20 upvotes we will move it to our backlog. If not, we will close it. To learn more about how we handle feature requests, please see our documentation.

Happy Coding!

[vitaliy-guliy]

I faced the same issue in Visual Studio Code web with multi-root workspace ( the workspace file looks like @valhuber described in his comment ).

Today I reproduced it in the desktop version. The first I thought that setting is not supported for multiroot, but having edited the workspace file I noticed the property its not colored into grey. So it should work for both single and multi-root.

I have only one question here. If I have several projects with README.md files, which one will be opened?

It would be nice as well to have an option to specify any file to be opened on the startup.

[vs-code-engineering[bot]]

This feature request has not yet received the 20 community upvotes it takes to make to our backlog. 10 days to go. To learn more about how we handle feature requests, please see our documentation.

Happy Coding!

[vs-code-engineering[bot]]

:slightly_smiling_face: This feature request received a sufficient number of community upvotes and we moved it to our backlog. To learn more about how we handle feature requests, please see our documentation.

Happy Coding!