Skip to content
Newer
Older
100644 106 lines (55 sloc) 3.05 KB
bf2a019 @petermichaux update README
authored Apr 26, 2012
1 Maria
2 =====
3
4b4aada @petermichaux clean up trailing whitespace
authored Jan 25, 2016
4 The 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
b4321e4 @petermichaux improve downloads links
authored Jun 1, 2013
18 See [http://peter.michaux.ca/downloads/maria/](http://peter.michaux.ca/downloads/maria/?C=M;O=D)
a9d9541 @petermichaux release candidates
authored Jul 7, 2012
19
d5ded4c @petermichaux create development builds and strip debugging code when creating prod…
authored Jun 21, 2013
20 There are several different built files from which to choose:
21
22 `maria.js` the main release of the framework. If in doubt, use this file.
f74801c @petermichaux add notes in downloads section about which file is which
authored Jul 6, 2012
23
d809380 @petermichaux formatting in README
authored Apr 8, 2013
24 `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
25
d5ded4c @petermichaux create development builds and strip debugging code when creating prod…
authored Jun 22, 2013
26 `maria-debug.js` contains additional code that is stripped when creating `maria.js`. This additional code points developers to potential problems with more informative console logging. `maria-debug.js` is a good file to use during development.
27
a9d9541 @petermichaux release candidates
authored Jul 7, 2012
28
534573d @petermichaux update readme to point to pretty documentation
authored Jul 29, 2012
29 Documentation
30 -------------
31
32a6359 @petermichaux update README
authored Apr 8, 2013
32 See [http://peter.michaux.ca/maria/](http://peter.michaux.ca/maria/)
534573d @petermichaux update readme to point to pretty documentation
authored Jul 30, 2012
33
34
35 Examples
36 --------
37
d809380 @petermichaux formatting in README
authored Apr 9, 2013
38 The `eg` directory contains several example applications.
534573d @petermichaux update readme to point to pretty documentation
authored Jul 30, 2012
39
40
41 Community
42 ---------
43
cdacd02 @petermichaux update README to use Github issues tracker instead of Google Groups f…
authored Dec 14, 2012
44 You can report bugs, suggest features, or join general discussion at https://github.com/petermichaux/maria/issues
534573d @petermichaux update readme to point to pretty documentation
authored Jul 30, 2012
45
46
cedb24e @petermichaux update README. No dependencies.
authored Apr 27, 2012
47 Status
48 ------
49
7a1495f @petermichaux preparing for 1.0.0 release
authored Jun 1, 2013
50 Stable.
cedb24e @petermichaux update README. No dependencies.
authored Apr 27, 2012
51
52
0a8a4ce @petermichaux add Browser Support section to README
authored Jul 6, 2012
53 Browser Support
54 ---------------
55
56 Tested working in IE6 and newer browsers by a variety of manufacturers.
57
58
94e7397 @petermichaux update README. No dependencies.
authored Apr 27, 2012
59 Dependencies
60 ------------
61
62 None. Maria combines several independent micro libraries which are all included.
63
64
76a86c7 @petermichaux add Source Code section
authored Jul 6, 2012
65 Source Code
66 -----------
67
c00a9fb @petermichaux update README
authored Apr 8, 2013
68 See https://github.com/petermichaux/maria
76a86c7 @petermichaux add Source Code section
authored Jul 7, 2012
69
70
aeea0dc @petermichaux build instructions in README
authored Apr 28, 2012
71 Build
72 -----
73
d809380 @petermichaux formatting in README
authored Apr 9, 2013
74 To build the production ready files, just type `make` at the command line and look in the `build` directory for the results. The first time you run `make`, it will download some libraries used during the build process and install them in the `lib` directory: [Google's Closure Compiler](https://developers.google.com/closure/compiler/) and [JSDoc3](https://github.com/jsdoc3/jsdoc).
aeea0dc @petermichaux build instructions in README
authored Apr 29, 2012
75
76
ff6acee @petermichaux update README
authored Apr 27, 2012
77 Tests
78 -----
79
d809380 @petermichaux formatting in README
authored Apr 9, 2013
80 To run the automated tests, open `tst/runner.html` in a web browser.
ff6acee @petermichaux update README
authored Apr 27, 2012
81
82
bf2a019 @petermichaux update README
authored Apr 27, 2012
83 Acknowledgements
84 ----------------
85
99894f5 @petermichaux fix README typo
authored Apr 8, 2013
86 Thanks to [James Ladd](http://jamesladdcode.com/) for encouraging me to start this project. Check out 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
87
88 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
89
90 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
91
92
93 Author
94 ------
95
ffd0e6f @petermichaux formatting
authored Jul 6, 2012
96 Peter Michaux<br>
97 petermichaux@gmail.com<br>
98 http://peter.michaux.ca/<br>
dc07fb2 @petermichaux link to twitter
authored Jul 7, 2012
99 [@petermichaux](https://twitter.com/petermichaux)
cee782c @petermichaux add Author and License sections to the README
authored Jul 7, 2012
100
101
102 License
103 -------
104
105 Simplified BSD License. See the included LICENSE file for details.
Something went wrong with that request. Please try again.