Skip to content
Newer
Older
100644 116 lines (64 sloc) 3 KB
bf2a019 @petermichaux update README
authored Apr 26, 2012
1 Maria
2 =====
3
ff6acee @petermichaux update README
authored Apr 27, 2012
4 An MVC framework for JavaScript applications. The real MVC. The Smalltalk MVC. The Gang of Four MVC.
bf2a019 @petermichaux update README
authored Apr 27, 2012
5
d2fd06e @petermichaux update README
authored Apr 26, 2012
6 * A model contains domain data. When a model changes, it informs its observers.
7
3379512 @petermichaux update README
authored Apr 28, 2012
8 * A view observes a model and represents its model's current state. A view has a controller. A view can have child views.
d2fd06e @petermichaux update README
authored Apr 27, 2012
9
0ff02f1 @petermichaux clarity in README
authored Jun 13, 2012
10 * A controller decides what happens when a user interacts with the controller's view.
e7dc200 @petermichaux update README
authored Apr 27, 2012
11
3379512 @petermichaux update README
authored Apr 28, 2012
12 The three core design patterns of MVC (observer, composite, and strategy) are embedded in Maria's Model, View, and Controller objects. Other patterns traditionally included in MVC implementations (e.g. factory method and template) make appearances too.
d2fd06e @petermichaux update README
authored Apr 27, 2012
13
14
a9d9541 @petermichaux release candidates
authored Jul 6, 2012
15 Downloads
16 ---------
17
18 See http://peter.michaux.ca/downloads/maria/
19
68589ff @petermichaux typo
authored Jul 6, 2012
20 ```maria.js``` contains all the Maria source files concatenated together. This is a good file to use during the development of your application.
f74801c @petermichaux add notes in downloads section about which file is which
authored Jul 6, 2012
21
965fd71 @petermichaux more info about maria-min.js
authored Jul 6, 2012
22 ```maria-min.js``` contains the same code as ```maria.js``` but ```maria-min.js``` has been minified to remove whitespace and code comments. This is a good file to serve in production.
f74801c @petermichaux add notes in downloads section about which file is which
authored Jul 7, 2012
23
a9d9541 @petermichaux release candidates
authored Jul 7, 2012
24
534573d @petermichaux update readme to point to pretty documentation
authored Jul 29, 2012
25 Documentation
26 -------------
27
28 See the doc directory which is also available at [http://peter.michaux.ca/maria/](http://peter.michaux.ca/maria/).
29
30
31 Examples
32 --------
33
34 The eg directory contains example applications including the canonical to-do application.
35
36
37 Community
38 ---------
39
40 Google Group: http://groups.google.com/group/maria-js
41
42 IRC: #maria.js on irc.freenode.net
43
44
cedb24e @petermichaux update README. No dependencies.
authored Apr 27, 2012
45 Status
46 ------
47
a9d9541 @petermichaux release candidates
authored Jul 7, 2012
48 Release candidates are in progress.
cedb24e @petermichaux update README. No dependencies.
authored Apr 27, 2012
49
50
0a8a4ce @petermichaux add Browser Support section to README
authored Jul 6, 2012
51 Browser Support
52 ---------------
53
54 Tested working in IE6 and newer browsers by a variety of manufacturers.
55
56
94e7397 @petermichaux update README. No dependencies.
authored Apr 27, 2012
57 Dependencies
58 ------------
59
60 None. Maria combines several independent micro libraries which are all included.
61
62
76a86c7 @petermichaux add Source Code section
authored Jul 6, 2012
63 Source Code
64 -----------
65
66 GitHub: https://github.com/petermichaux/maria
67
68
aeea0dc @petermichaux build instructions in README
authored Apr 28, 2012
69 Build
70 -----
71
ea9a2d2 @petermichaux add JSMin build instructions
authored Apr 30, 2012
72 To build the production ready files, you need [JSMin](http://www.crockford.com/javascript/jsmin.html) or any other tool with the same command line interface. Then just type "make" at the command line and look in the build directory for the results.
73
8b774e6 @petermichaux more README
authored Apr 30, 2012
74 For the record, this is how I installed JSMin. Note that I have /Users/peter/bin in my PATH.
ea9a2d2 @petermichaux add JSMin build instructions
authored Apr 30, 2012
75
e806937 @petermichaux try sh highlighting
authored Apr 30, 2012
76 ```sh
ea9a2d2 @petermichaux add JSMin build instructions
authored Apr 30, 2012
77 $ cd ~/tmp
78 $ curl -O https://raw.github.com/douglascrockford/JSMin/master/jsmin.c
79 $ gcc -o jsmin jsmin.c
80 $ mv jsmin ~/bin
81 $ rm jsmin.c
82 $ which jsmin
83 /Users/peter/bin/jsmin
84 ```
aeea0dc @petermichaux build instructions in README
authored Apr 29, 2012
85
86
ff6acee @petermichaux update README
authored Apr 27, 2012
87 Tests
88 -----
89
90 To run the automated tests, open tst/runner.html in a web browser.
91
92
bf2a019 @petermichaux update README
authored Apr 27, 2012
93 Acknowledgements
94 ----------------
95
96 Thanks to [James Ladd](http://jamesladdcode.com/) for encouraging me to start this project. Checkout his [Redline Smalltalk](http://www.redline.st/) if Smalltalk on the JVM seems like a good idea to you.
ff6acee @petermichaux update README
authored Apr 27, 2012
97
98 Thanks to the [Buster.JS](http://busterjs.org/) development team for providing a great, automated testing tool.
893f968 @petermichaux acknowledge Git and GitHub
authored Jul 6, 2012
99
100 Thanks to the Git and GitHub teams for making it easy to collaborate with others on code projects.
cee782c @petermichaux add Author and License sections to the README
authored Jul 6, 2012
101
102
103 Author
104 ------
105
ffd0e6f @petermichaux formatting
authored Jul 6, 2012
106 Peter Michaux<br>
107 petermichaux@gmail.com<br>
108 http://peter.michaux.ca/<br>
dc07fb2 @petermichaux link to twitter
authored Jul 7, 2012
109 [@petermichaux](https://twitter.com/petermichaux)
cee782c @petermichaux add Author and License sections to the README
authored Jul 7, 2012
110
111
112 License
113 -------
114
115 Simplified BSD License. See the included LICENSE file for details.
Something went wrong with that request. Please try again.