amethyst-framework / amethyst

Amethyst is a Rails inspired web-framework for Crystal language
https://github.com/amethyst-framework
MIT License
648 stars 46 forks source link

Use the project name in the require #32

Closed zamith closed 8 years ago

zamith commented 8 years ago

Because of how Crystal's require works, the example wouldn't work if you're deploying it to Heroku, for instance (maybe there are other situations).

As far as I could understand it depends on your system considering "Amethyst/amethyst.cr" to exist, when asking for "amethyst/amethyst.cr".

The other solution would be to rename the project to use a lowercase "A", since that's what Crystal is expecting, from what I can tell. Maybe @asterite can shed more light on the matter.

asterite commented 8 years ago

Another solution is to have a file src/Amethyst.cr that is just like the current src/amethyst.cr. Then you can do require "Amethyst".

But yes, project names should be lowercase and the convention is to have a file src/... named exactly as the project name, so probably the project should be renamed to its lowercase version.

Codcore commented 8 years ago

OK, I'll rename project to 'amethyst'