JohnByrneRepo / mddir

Mddir generates a markdown file/folder structure for readme files
Other
215 stars 45 forks source link

Making project executable #1

Closed mcadelago closed 8 years ago

mcadelago commented 9 years ago

I wanted to use this in a different way than the project previously functioned. Here's how it works now with this PR:

To install: npm install mddir -g

To generate markdown for current directory: mddir

To generate for any absolute path: mddir /absolute/path

To generate for a relative path: mddir ~/Documents/whatever

The md file gets generated in your working directory instead of in the mddir project folder. Let me know what you think.

mcadelago commented 9 years ago

If you want to test this out, pull down the code and run npm install . -g from the root of the project directory. You won't be able to install using the project name until after you merge this code in

JohnByrneRepo commented 9 years ago

Hi @ex1machina, apologies for the late response and thanks for making this change - I'd been meaning to make this executable for added convenience. Also, excellent solution to specifying absolute or relative paths. I'll try this out asap then merge into master.

I'm also planning on an alternative display within the browser, as the main goal was to provide a user with a method of familiarising themselves with a project rather than generating markdown exclusively. If I add this functionality, then I will generate the markup and any required JavaScript and css from node.

rstoenescu commented 8 years ago

:thumbsup: I just found this project and I would've made the same PR. Good job.

Koleok commented 8 years ago

@JohnByrneRepo Any plans to merge this? Would love to use mddir but it really needs this PR

JohnByrneRepo commented 8 years ago

Merged. Definitely needed, and thanks for the additions. I should also be adding better ignore list functionality at some point. Thanks for the support :+1:

Koleok commented 8 years ago

Nice thanks @JohnByrneRepo