achiurizo / consular

Terminal automation
http://rdoc.info/github/achiu/consular/master/file/README.md
MIT License
813 stars 46 forks source link

What is this project? #101

Open CyberShadow opened 9 years ago

CyberShadow commented 9 years ago

I was going through the oh-my-zsh plugins list:

https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins

I was checking out all software projects mentioned there that I had never heard of.

There, I found the entry:

terminitor is a tool that "automates your development workflow setup".

I didn't understand what that means on its own, so I followed the link to the GitHub project:

https://github.com/achiu/terminitor

The README says:

Consular automates your development workflow setup.

Read the rest of the README and check out the wiki for more info!

I click through to the wiki:

https://github.com/achiu/consular/wiki

Again, the same phrase and no more general information about the project.

I click through to the new project page:

https://github.com/achiu/consular

Same.

I suggest that you add a paragraph to the README describing what the project does and who it will be useful for.

nethermead commented 4 years ago

I had to infer what it did and then ran a test with iTerm to verify. It's cool, but not clear.

Also, configuration isn't clear at all. consular edit test tries to open test.term to edit but .term files are default to iTerm and it shows a file corrupted dialog. Is there a way to specify an editor?