Move (or remove) the installation root README file to source code #25
Description
Feature Summary
Move (or completely remove) the README file that is created during installation. I personally never even realized it existed until I accidentally broke some path resolution logic and installation started failing. It has some light information in it, all of which is well covered by our docs. I want us to heavily consider just removing this file and including a docs link in the CLI help command or something like that. But if it must stick around, then can we at least store the relatively simple contents as a string in source so we can avoid the FS op and path resolution complexity?
I understand if the file was more complex we may want to retain it as markdown source so we could leverage like markdown dev tools (linting, formatting, link checking, etc.)
Problem This Solves
Ref #16, similar justification to #24, we are incurring unnecessary costs by reading this README file during installation.
Proposed Solution
- Remove the file
Alternative:
- Move file contents to a JS string
User Stories
No response
Alternatives Considered
No response
Priority/Impact
Low - nice to have
Examples or References
No response
Additional Context
No response
Are you planning to fix this issue?
No, just reporting the issue
First-time contributor support
- I'm new to contributing and would appreciate guidance on the process
- I'd like help understanding the project structure
- I need assistance with setting up the development environment
- I'm comfortable contributing, but new to this project specifically