Skip to content

README.md

Latest commit

 

History

History
36 lines (23 loc) · 688 Bytes

README.md

File metadata and controls

36 lines (23 loc) · 688 Bytes

Structure tree 🌳

A simple CLI program that adds a tree-like structure to your README.MD file, like:

Project Structure

  • go.mod
  • helpers.go
  • main.go
  • structure

How to Run

  1. Navigate to your Go code directory and run the following command to create an executable:
go build -o structure
  1. Move the structure app into /usr/local/bin:
mv structure /usr/local/bin
  1. Now, go to any folder and run the structure command:
structure .

This will append a tree-like structure of the project to your README.md file. If README.md doesn't exist, it will create one.

Don't have Go installed?

Go to Go for more info.