Skip to content

README.md

Latest commit

 

History

History
27 lines (21 loc) · 762 Bytes

README.md

File metadata and controls

27 lines (21 loc) · 762 Bytes

Introduction

To autogenerate SCANME.md, you can globally pip install metadir, and type metadir ..

Usage

Running command metadir . to generate SCANME.md content.

- '*': ''
  README.md: {'*': ''}
  src:
    - '*': ''
      main.py: {'*': ''}
      main.js: {'*': ''}
      core:
        - '*': ''
          app.py: {'*': ''}
  docs:
    - '*': ''
      index.md: {'*': ''}

The values at each level provide ability to specify metaformat for each file and directory in the project by providing URLs to schema specifications.

TODO

  • Implement ignoring of files based on .gitignore, and using regex (look for strings SKIP in the project).