search

petermichaux / maria

The MVC framework for JavaScript applications. The real MVC. The Smalltalk MVC. The Gang of Four MVC.
BSD 2-Clause "Simplified" License
764 stars 51 forks source link

Offer a built solution for a quick start #3

Closed gersongoulart closed 11 years ago

gersongoulart commented 11 years ago

Maria is great but having to download the whole repository, install dependencies and build the solution in order to get started with Maria can be a bit time consuming and discourage people to start playing around with the project.

Just a suggestion, but having a dist directory containing the built Maria both in dev version (pretty with comments) and the minified version would be great to offer the community a quick starting point. The example applications within eg could even use this minified version as a way to show off how it'd do in production...

Again, food for thought ;)

petermichaux commented 11 years ago

How about the built files that are linked to from the Downloads section of the README?

https://github.com/petermichaux/maria#downloads

gersongoulart commented 11 years ago

It's out of the repo :tada: :baby: :baby_bottle:

I'd have to download it separately from the examples and manually put them back together to see it working. Besides, you can't have an static shell script (or bower | volo | ender | yoman | younameit) do something like:

$ curl -O http://peter.michaux.ca/downloads/maria/rc4/maria-min.js

and expect it to have the latest and greatest. I'd always have to manually update the version number in the url.

Also, I have no idea what maria-core.js is and what is the difference to maria.js. It can be confusing since I'd don't know which would be better for me to download. Is maria-core the maria script without it's dependencies?

petermichaux commented 11 years ago

It's out of the repo

Yes the built files are out of the repository intentionally. I was taught and agree with the philosophy that only source files should be in the source control repository. Anything that is a built file cannot be committed to the source repository. Doing so is redundant and makes understanding the source tree and change sets more complicated.

I'd have to download it separately from the examples and manually put them back together to see it working.

When you clone the repository, the included examples work immediately. There is no need to build anything.

you can't have an static shell script (or bower | volo | ender | yoman | younameit) do something like: ...and expect it to have the latest and greatest. I'd always have to manually update the version number in the url.

That is a good point. I've addd a symbolic link in the downloads folder that will always point to current.

http://peter.michaux.ca/downloads/maria/current/

Also, I have no idea what maria-core.js is and what is the difference to maria.js.

maria-core.js was a different build of Maria without the subclass sugar. I no longer think it is valuable and have deleted it. I'll remove it from the build process in the Makefile also.

petermichaux commented 11 years ago

Makefile now updated to no longer make maria-core.js file.

I think that is all to be done for this ticket.

gersongoulart commented 11 years ago

Wow, fast and precise! :D Great job!