This page will give you recommendations on how to write README.md file for your Angular project.

Topics

    README.md
    ├── Documentation
    │   ├── Wireframe/Mock-up
    │   │   # or any design for the project
    │   │
    │   └── API Documentation
    │       # such as how to access it, credential (if any)
    │
    ├── Application URLs
    │   # URLs for local development, development server, staging (if any) server, and production server.
    │
    ├── Requirements
    │   # requirement version of Docker, Docker-Compose, etc.
    │
    ├── Setup Project
    │   # Steps for setup project for the first time.
    │
    ├── Run Project
    │   # Steps for running project after developer have already setup the project.
    │
    ├── Accounts
    │   # Account for login to application for admin and regular user.
    │
    ├── Miscellaneous Tools
    │   ├── Linting Project
    │   │   # Steps for linting project
    │   │
    │   └── Testing Project
    │       # Steps for testing project
    │
    └── Other topics
         # For example, troubleshooting, feature flags, monitoring systems, etc.

Example

See sample here