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

Topics

    README.md
    ├── 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.
    │
    ├── Account
    │   ├── API
    │   │    # Account for login to localhost API for admin and regular user
    │   └── DB
    │        # Account for access localhost DB.
    │
    ├── Miscellaneous Tools
    │   ├── Clean Project
    │   │   # Steps for cleaning project (clear project docker image/containers, reset db)
    │   │
    │   ├── Reset DB
    │   │    # Steps for reset DB
    │   │
    │   ├── Dump DB
    │   │    # Steps for dump localhost DB
    │   │
    │   └── Restore DB
    │        # Steps for restore localhost DB
    │
    └── Other topics
         # For example, custom config Celery/RabbitMQ, setup some complex data, etc.

Example

See sample here