Document if .iris.yml should be git ignored or not.

[goenning]

What's the recommendation on .iris.yml? It seems like the "Dest" property contains the full path of the source, which can be different per developer. I assume this means it should not be commited to git? What's your suggestion here.

Also, have you though of naming the binary simply 'iris' instead of 'iris-cli'? Similar to rails and buffalo, for example

[kataras]

Hello,

The .iris.yml file should be ignored and the tool does it automatically on iris-cli init (it adds the .iris.yml to .gitignore automatically, if not already exist).

Also, all project templates have the .iris.yml on their .gitignore files too, e.g https://github.com/iris-contrib/mvc-template/blob/654443676d149f57f1c9b242c094790466ff8c6d/.gitignore#L7.

So there is nothing to recommend, the tool should take care of these things automatically. All settings saved in .iris.yml (including options like live reload, build files and e.t.c) depends on the environment, so each contributor should have its own .iris.yml version, at least this is the idea so far.

Also, have you though of naming the binary simply 'iris' instead of 'iris-cli'? Similar to rails and buffalo, for example

To be honest, I asked the same question to myself some years ago. After a lot of thinking, a separate repository with iris-cli is better. We had an iris thing lived inside the kataras/iris/iris and users were really confused, I am not making the same mistake.

Both rails and buffalo(who uses buffalo lol?! We've tried to make some benchmarks and we did an hour to get started, and by we I mean me and other 5+ years experience gopher! The results were drama...even the slowest nodejs framework was twice as fast) require so many configuration for a developer to get started, without reason, so their cli is required to get started, so they gave the same name in two different things (a cli tool and a web framework library), in Iris you can get started with 4 lines of code no cli is required and shouldn't be installed to users if they didn't explicitly ask for it. Clear and simple. Also the iris-cli can work with non-iris projects too 🚀

EDIT: I added a note about .iris.yml, even if the tool takes care of it, you asked, so others may have the same question. Thanks for opening this issue @goenning