Skip to content

Commit

Permalink
#o2js more README.
Browse files Browse the repository at this point in the history
  • Loading branch information
v0lkan committed May 28, 2012
1 parent a1bed46 commit 3972c4a
Show file tree
Hide file tree
Showing 7 changed files with 132 additions and 33 deletions.
28 changes: 27 additions & 1 deletion CHANGELOG.md
@@ -1 +1,27 @@
# **o2.js** Change Log
___ _
____ |__ \ (_)____
/ __ \__/ / / / ___/
/ /_/ / __/_ / (__ ) A Coherent Solution
\____/____(_)_/ /____/ to Your JavaScript Dilemma ;)
/___/

**[o2.js](http://o2js.com/)** Change Log
--------------------------------------------------------------------------------

### **[o2.js](http://o2js.com/)** v.0.25

* Still work in progress.
* There are lots of patches to add.
* Unit tests are being written from the grounds up.

### **[o2.js](http://o2js.com/)** v.0.24

* This version has been actually used in a **mobile** and **desktop** app
production environments (for <http://grou.ps/> mobile and desktop apps, that
has been used and tested by hundreds of thousands of users).
The code is improved and got fixed by looking at user feedback and bug reports
accordingly. I'd like to thank <http://grou.ps> once more for their support
in **open source** development.
* Many stability improvments have been done.
* Created a set of unit test, that can be run automatically before each
major release.
18 changes: 18 additions & 0 deletions CONTRIBUTORS.md
@@ -0,0 +1,18 @@
___ _
____ |__ \ (_)____
/ __ \__/ / / / ___/
/ /_/ / __/_ / (__ ) A Coherent Solution
\____/____(_)_/ /____/ to Your JavaScript Dilemma ;)
/___/

[o2.js](http://o2js.com/)** Contributors
--------------------------------------------------------------------------------

In alphabethical order:

* **Jose Capablanca** ([github](https://github.com/josecapablanca))
* **Volkan Özçelik**
([geeklist](http://geekli.st/volkan) /
[twitter](http://twitter.com/linkibol) /
[blog](http://o2js.com/))
* ([who else wants to contribute and be in this list?](https://github.com/v0lkan/o2.js/blob/master/WE_LOVE_YOU.md))
10 changes: 10 additions & 0 deletions CONVENTIONS.md
@@ -1,6 +1,16 @@
___ _
____ |__ \ (_)____
/ __ \__/ / / / ___/
/ /_/ / __/_ / (__ ) A Coherent Solution
\____/____(_)_/ /____/ to Your JavaScript Dilemma ;)
/___/

# o2.js **JavaScript** Conventions & Best Practices

## An **All-in-One** Guide to Writing Efficient **JavaScript** *;)*

**Last Updated**: *2012-05-27 19:52:29.609752*

--------------------------------------------------------------------------------

## Introduction
Expand Down
17 changes: 11 additions & 6 deletions INSTALL.md
@@ -1,17 +1,22 @@
Installation and Configuration Instructions
___ _
____ |__ \ (_)____
/ __ \__/ / / / ___/
/ /_/ / __/_ / (__ ) A Coherent Solution
\____/____(_)_/ /____/ to Your JavaScript Dilemma ;)
/___/

**[o2.js](http://o2js.com/)** Installation and Configuration Instructions
--------------------------------------------------------------------------------

# o2.js Development Environment Setup

To view and build the **o2.js** examples locally you need the following set up:

* **Java(TM) SE Runtime Environment** <http://www.java.com/en/>
* **Java SE Runtime Environment** <http://www.java.com/en/>
* **Apache Server** <http://httpd.apache.org/> (you can also use
[MAMP](http://mamp.info/en/index.html) for **Mac OSx**,
[WAMP](http://www.wampserver.com/en/) for **Windows**, and
[it is really easy](https://help.ubuntu.com/community/ApacheMySQLPHP) to insall
a **LAMP** stack on linux)
* [**Node.js**](http://nodejs.org/) (not required right now, but it's
* [**node.js**](http://nodejs.org/) (not required right now, but it's
**cool** to have NodeJS on your machine)

After having all those set up, the following things should be done:
Expand Down Expand Up @@ -60,4 +65,4 @@ You should see something like this:

//TODO: insert image.

That's it. You're ready to test **o2.js** locally.
That's it. You're ready to test **[o2.js](http://o2js.com/)** locally.
13 changes: 12 additions & 1 deletion LICENSE.md
@@ -1,4 +1,15 @@
Copyright © by **Volkan Özçelik** - <http://o2js.com/>
___ _
____ |__ \ (_)____
/ __ \__/ / / / ___/
/ /_/ / __/_ / (__ ) A Coherent Solution
\____/____(_)_/ /____/ to Your JavaScript Dilemma ;)
/___/

Copyright © by [**Volkan Özçelik**](http://o2js.com/volkan), and community.
You can look at the [contributors list](https://github.com/v0lkan/o2.js/blob/master/CONTRIBUTORS.md)
to see the people adding value to [**o2.js**](http://o2js.com/).

**LICENSE**

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
68 changes: 43 additions & 25 deletions README.md
Expand Up @@ -106,13 +106,13 @@ higly recommend you read it **;)**)
is the way to go.

See [Installation and Configuration Instructions][6]
for a more in-depth information on how to set up **o2.js** for
for a more in-depth information on how to set up *[o2.js][2]** for
local development.

A Quick Example
--------------------------------------------------------------------------------

Here is a quick code sample to give you a feeling of **o2.js** :
Here is a quick code sample to give you a feeling of *[o2.js][2]** :

(function(o2, window, document, undefined) {
'use strict';
Expand Down Expand Up @@ -151,10 +151,12 @@ The directory structure of the project is as follows:
* **batch**: Documentation, deployment, and configuration scripts.
* **doc**: Generated documentation.
* **examples**: Sample projects and usage examples (*work in progress*).
* **o2.js**: The **o2.js** Framework source files.
* **o2.js**: The *[o2.js][2]** Framework source files.
* **tests**: Unit tests (*they are being rewritten*).
* **[CHANGELOG.md][9]: What's new in the current version. What development has
been done so far.
* **[CONTRIBUTORS.md][11]: List of people adding value to **[o2.js][2]**.
[Who else wants to be one of them?][5]
* **[CONVENTIONS.md][7]**: Code conventions and best practices for those who
want to contribute.
* **[INSTALL.md][6]**: Installation and configuration instructions for the
Expand All @@ -166,52 +168,66 @@ is distributed under **MIT** license, so feel free to **fork it**.
Where Can I Get Help?
--------------------------------------------------------------------------------

//TODO: update me.
Here a the places you can get help:

* If you are experiencing a problem, or if you have found a bug, or if you
want some cool sh\*t to be implemented
[you can open an issue for it](https://github.com/v0lkan/o2.js/issues/new).
* If you want to figure out how a function works, you can look at the
[**o2.js** API documentation][10].
* If you want learn the history of **[o2.js][2]**, and want to keep an eye on
what cool things will be added to it in the future
[you can follow **o2.js** blog][2].

Where is the Documentation?
--------------------------------------------------------------------------------

//TODO: update me.
The most up-to-date documentation is under the **doc** folder of this
repository. Other than that you can find a "mostly" recen **API** documentation
at [**o2js.com**/documentation][10]

Contribution Guidelines
--------------------------------------------------------------------------------

//TODO: add contribution guidelines.
//instructions to submit bugs, feature requests, submit patches,
//get announcements
**Bottom Line Up Front**:

**[o2.js][2]** is an **open source** project, and **anyone** can contribute.
You do not to be a guru, or a ninja, to add value. Heck, you don't even need
to know how to code (there are other ways that you can contribute **;)**).

Having said that; make sure you **carefully** read
[**o2.js** Contribution Guidelines][5] before you start.

Contributor List
--------------------------------------------------------------------------------

* **Volkan Özçelik**
([geeklist](http://geekli.st/volkan) /
[twitter](http://twitter.com/linkibol) /
[blog](http://o2js.com/))
* **Jose Capablanca** ([github](https://github.com/josecapablanca))
* ([who else wants to contribute and be in this list?][5])
You can look at the [contributors list][11] to see the people adding value to
**o2.js**.

**Anyone** can be a contributor.

[Who else wants to learn how to?][5]

Change Log
--------------------------------------------------------------------------------

//TODO: link to changelog, maintain changelog.
[You can view the **o2.js** Change Log here][9].


License
--------------------------------------------------------------------------------

//TODO: link to changelog, maintain changelog.
**[o2.js][2]** is distributed under **MIT** license.
You can play with it however you like.

See [LICENSE.md][8] for details.

Contact Information
--------------------------------------------------------------------------------

//TODO: update me.
//(email address, website, company name, address, etc)
**Project Owner**: *Volkan Özçelik* <volkan@o2js.com>
**Project Website**: <http://o2js.com>

___ _
____ |__ \ (_)____
/ __ \__/ / / / ___/
/ /_/ / __/_ / (__ ) A Coherent Solution
\____/____(_)_/ /____/ to Your JavaScript Dilemma ;)
/___/

[1]: http://linkedin.com/in/volkanozcelik "Volkan Özçelik (LinkedIn)"
[2]: http://o2js.com/ "o2js.com - A Coherent Solution to Your JavaScript Dilemma"
Expand All @@ -221,4 +237,6 @@ Contact Information
[6]: https://github.com/v0lkan/o2.js/blob/master/INSTALL.md "Installation and Configuration Instructions"
[7]: https://github.com/v0lkan/o2.js/blob/master/CONVENTIONS.md "Code Conventions and Best Practices"
[8]: https://github.com/v0lkan/o2.js/blob/master/LICENSE.md "Boring Copyright Stuff"
[8]: https://github.com/v0lkan/o2.js/blob/master/CHANGELOG.md "Change Log"
[9]: https://github.com/v0lkan/o2.js/blob/master/CHANGELOG.md "Change Log"
[10]: http://o2js.com/documentation "o2.js API Documentation"
[11]: https://github.com/v0lkan/o2.js/blob/master/CONTRIBUTORS.md "Contributors"
11 changes: 11 additions & 0 deletions WE_LOVE_YOU.md
@@ -0,0 +1,11 @@
___ _
____ |__ \ (_)____
/ __ \__/ / / / ___/
/ /_/ / __/_ / (__ ) A Coherent Solution
\____/____(_)_/ /____/ to Your JavaScript Dilemma ;)
/___/

How Can I Contribute to **[o2.js](http://o2js.com/)**
--------------------------------------------------------------------------------

//TODO: complete me.

0 comments on commit 3972c4a

Please sign in to comment.