Search code examples
structure

take the structure of any project


I have seen the project structure on readMe, how can I take this structure of my project, any program? any website. doesn't seems right to me to create by hand? enter image description here


Solution

  • Yes, there is a very simple way to get it.

    Navigate to the root folder of your project and run tree from your terminal. You should get something like this:

    project_root
    │   README.md    
    │
    └───some_folder
    │   │   another_file.txt
    │   │   some_code.code
    │   │
    │   └───some_subfolder
    │       │   some_more_code.txt
    │       │   another_file.txt
    │       │   a_picture.png
    │       │   ...
    │   
    └───another_folder
        │   more_files.txt
        │   more_code.code
        ...
    

    Now you can copy and paste this tree into your README file, wrapping it in triple backticks - ``` to get the markdown styling.