Skip to content

Generate readme.md #1675

@checktravis

Description

@checktravis

What problem does this feature solve?

Currently, every new project is generated with no readme.md file. Generating a readme.md with basic deployment information would help rapid prototyping. The end user will have a starting point to expand upon. Example:

# my-vue-project

## Build Setup

### dependencies:
npm install # Or yarn install

### spin up server with hot reload (npm run / yarn)
npm run serve

### build for production
npm run build

### review configuration
npm run inspect

## Made with [vue-cli](https://cli.vuejs.org/).

What does the proposed API look like?

# client would either generate a generic readme.me or enhanced with provided details (project-name, selected plugins, etc)
vue create my-vue-project

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions