xeoncross/micromvc

Where is the documentation?

Opened this issue · 10 comments

Where is the documentation?

I'm afraid at this point there is no documentation outside of the heavily commented code. MicroMVC works much the same as any other MVC framework. Most classes are only a few kilobytes in size, so reading through the system isn't a very hard task. Feel free to contribute wiki pages.

You start by creating classes inside the Class folder that match your controllers and models. Then you add views to View. Checkout the three sample controllers to see how easy it is.

Bad that there is even a page with an example of use.

Is there any planing about document?
It's very important for developers to save time, and help beginers to learn it easy.

From many reviews, I would like to use this lightweight framework. However, I don't know where I could start.
If you have a free time, show me a way how to echo hello world. Thanks guy

Same thing here. Absolutly no clue where to start and where to define how to handle a specific route. Seriously, this is why wonderful projects like this will totally fail: Because nobody knows how to use it and it has not even a simple single example page. It's like producing a TV Remote Control without icons on the buttons. Unuseable.

@panique you are absolutely right.

Ask again.Is there any planing about document?

Well, there have always been plans for documentation. However, I'm not sure that I can give a "yes" answer because so far it has not happened. I'm afraid right now the well-commented code is all we have.

Could you please give me an example for loading a unique row of a Model ? Without using the Database class or using the fetch() method, but with a Orm\User class for example.
In the School example, you use only the fetch() and load() methods and there are many other ones like objects(), select(), column() and row() which I loved to use ;-)

However the all code is very very cool, love it.
Lack of doc is not so terrible...

I haved just understand :

new \ORM\Client(3260);

;-)