owensteele / greadr

Build formatted MD and TXT dir maps for you projects or domains- PShell and Go

GReadr - Git Readme Builder

By Owen Steele 2021

GReadr is designed to help map out and visual project repo directories, for both the makers and visitors!

GReader is built in Go and Powershell

Sample product below:

GReadr Dir Tree

Created with greadr(https://github.com/OwenSteele/greadr)

ROOT_FOLDER

|   greadr.json

|   greadr.ps1

|   greadrsetup.exe

|   \---greadr

|       \---v16

+---commands

|   |   greadr-help.ps1

|   |   greadr-info.ps1

|   +---app

|   |       remove-greadr-alias.ps1

|   |       set-greadr-alias.ps1

|   |       set-up-greadr.ps1

|   |       uninstall-greadr.ps1

|   +---common

|   |       confirm-file-exists.ps1

|   +---git

|   |       update-git-ignore.ps1

|   +---goCommands

|   |       invoke-readme-tree.ps1

|   \---output

|           write-data-files.ps1

|           write-json-files.ps1

+---go

|       ReadmeTree.go

+---greadr

|       after.md

|       before.md

\---templates

        default.json

        jupyter.json

        text.json

Installing and Setup

greadrsetup.exe

• Open the app and setup
  • Installs Go Lang Compiler if needed
  • Creates required config files
  • Adds GReadr to powershell profile

The installer is large ~80MB

Use file size filter to clone without the installer (see manual installation):

 > git clone --filter=blob:limit=50m https://github.com/OwenSteele/greadr

Manual installation

Simply clone or download the Zip to any folder to get started.

• In powershell, navigate to the root folder and type:

 > ./greadr.ps1 --setup 

• Go Lang compiler is required, setup will help with it's installation https://golang.org/doc/install
• Once set up, greadr should be usable in any folder.

 > greadr --help

Config

• GReadr uses a JSON file for configuration and options
• Templates can be used, which are saved in the greadr installation folder
• Custom config files can be created and edited:

 > greadr --create-json [templateType]

GReadr files can be added to your .gitignore:

 > greadr --ignore-greadr

Ignoring from the dir map

Can omit:

• entire folders

• file type extensions (e.g. "*.exe")

• file names (including and excluding file extension)

• partial names (i.e. contains "x")

• GReadr files can be omitted from the map produced (on by default)

• Git files (.gitignore, .git/, LICENSE) can also be omitted (on by default)

Created files

Can set any name or file extension with Output

Formatting

• Can set the dir map title, that appears above the map
• Double Space files/folders in map (useful for small projects)
• Omit 'Empty' lines that contain no files or are new folder spacers

Data

• This determine text or content that will be included before and after the map
  • (This text now is in the 'after.md' file!)
• Can use a file or JSON value text, or even both as providers

!PLEASE NOTE: there are required properties for custom config files:

• Output, both 'name' and 'type' fields are required
• Boolean types fields should not be removed

Issues

Powershell execution policy may need to be altered to run GReadr:

 > set-executionpolicy -executionpolicy unrestricted
OR
 > powershell.exe -executionpolicy unrestricted -command ./greadr.ps1

Planned Features

• Compile to .exe
• Making requirement of Go optional
• rewrite in bash, and for CMD
• add more config options in the JSON files