README.md in trema-0.2.2.1 vs README.md in trema-0.2.3
- old
+ new
@@ -1,46 +1,11 @@
-Trema 
-=====
-An Open Source modular framework for developing OpenFlow controllers in Ruby/C
+Welcome to Trema
+================
+Trema is a OpenFlow controller framework that includes everything
+needed to create OpenFlow controllers in Ruby and C.
-What's Trema?
--------------
-
-Welcome to the Trema OpenFlow programming framework. The scope of
-Trema is to help developers to easily create their own OpenFlow
-controllers, and NOT aiming at providing a specific OpenFlow
-controller implementation.
-
-
-Getting Started
----------------
-
-Trema requires several third-party software. You can install the
-prerequisites as follows:
-
- $ sudo apt-get install gcc make ruby ruby-dev irb file libpcap-dev libsqlite3-dev
-
-Download Trema source tree then run its build script:
-
- $ ./build.rb
-
-NOTE: Trema has been tested ONLY on the following environments:
-
-* Ubuntu 11.10 (i386/amd64, Desktop Edition)
-* Ubuntu 11.04 (i386/amd64, Desktop Edition)
-* Ubuntu 10.10 (i386/amd64, Desktop Edition)
-* Ubuntu 10.04 (i386/amd64, Desktop Edition)
-* Debian GNU/Linux 6.0 (i386/amd64)
-
-It may also run on other GNU/Linux distributions but is not tested and
-NOT SUPPORTED at this moment.
-
-
-What's here?
-------------
-
This distribution includes all the source code of Trema you need to
develop your own OpenFlow controllers. The source tree includes basic
libraries and functional modules that work as an interface to OpenFlow
switches.
@@ -49,87 +14,68 @@
controllers. Additionally, a simple but powerful framework that
emulates an OpenFlow-based network and end-hosts is provided for
testing your own controllers. For debugging, a wireshark plug-in to
diagnose internal data-flows among functional modules is provided.
-Please refer to the quick start guide
-(https://github.com/trema/trema/wiki/Quick-start) for details.
+Getting Started
+---------------
+1.Install the prerequisites at the command prompt:
+
+ $ sudo apt-get install gcc make ruby rubygems ruby-dev irb libpcap-dev libsqlite3-dev
+
+2.Install Trema at the command prompt:
+
+ $ sudo gem install trema
+
+3.Follow the guidelines to start developing your OpenFlow controller. You may find the following resources handy:
+
+* The [Getting Started with Trema](https://github.com/trema/trema/wiki/Quick-start).
+* The [Trema in 10 Minutes Tutorial](http://trema-10min.heroku.com/).
+* The [Trema Tutorial](http://trema-tutorial.heroku.com/).
+* The [Trema Ruby API documents](http://rubydoc.info/github/trema/trema/master/frames).
+* The [Programming Trema Article (in Japanese)](http://gihyo.jp/dev/serial/01/openflow_sd/0007).
+
+
Meta
----
-* Ruby API documents: http://rubydoc.info/github/trema/trema/master/frames
+* Web Page: http://trema.github.com/trema/
* Bugs: https://github.com/trema/trema/issues
* Mailing List: https://groups.google.com/group/trema-dev
* Twitter: http://twitter.com/trema_news
-* Web Page: http://trema.github.com/trema/
-Authors
--------
+Supported Platforms
+-------------------
-Please keep the list sorted.
+Trema has been tested ONLY on the following environments:
-* Kazushi Sugyo
-* Kazuya Suzuki
-* Lei Sun
-* Nick Karanatsios <nickkaranatsios@gmail.com>
-* Shin'ya Zenke
-* Shuji Ishii
-* Sundell Jari <sundell.software@gmail.com>
-* Toshio Koide
-* Yasuhito Takamiya <yasuhito@gmail.com>
-* Yasunobu Chiba
-* Yasunori Nakazawa
+* Ubuntu 12.04, 11.10, 11.04, 10.10, and 10.04 (i386/amd64, Desktop Edition)
+* Debian GNU/Linux 6.0 (i386/amd64)
+It may also run on other GNU/Linux distributions but is not tested and
+NOT SUPPORTED at this moment.
-### Contributors
-Thanks to:
+Contributors
+------------
-* Initial Helios development team for implementing prototype versions.
-* HIDEyuki Shimonishi for providing much-needed coffee, snacks, and christmas cakes!
-* Anonymous alpha/beta testers for finding potential issues.
+Special thanks to all contributors for submitting patches. A full list of contributors including their patches can be found at:
+https://github.com/trema/trema/contributors
-License & Terms
----------------
-Copyright (C) 2008-2012 NEC Corporation
+Project Status
+--------------
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License, version 2, as
-published by the Free Software Foundation.
+* Build Status [](http://travis-ci.org/trema/trema)
+* Dependency Status [](https://gemnasium.com/trema/trema)
-This program is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-General Public License for more details.
+License
+-------
-### Terms
+Trema is released under the GNU General Public License version 2.0:
-Terms of Contributing to Trema program ("Program")
-
-Please read the following terms before you submit to the Trema project
-("Project") any original works of corrections, modifications,
-additions, patches and so forth to the Program ("Contribution"). By
-submitting the Contribution, you are agreeing to be bound by the
-following terms. If you do not or cannot agree to any of the terms,
-please do not submit the Contribution:
-
-1. You hereby grant to any person or entity receiving or distributing
- the Program through the Project a worldwide, perpetual,
- non-exclusive, royalty free license to use, reproduce, modify,
- prepare derivative works of, display, perform, sublicense, and
- distribute the Contribution and such derivative works.
-
-2. You warrant that you have all rights necessary to submit the
- Contribution and, to the best of your knowledge, the Contribution
- does not infringe copyright, patent, trademark, trade secret, or
- other intellectual property rights of any third parties.
-
-3. In the event that the Contribution is combined with third parties'
- programs, you notify to Project maintainers including NEC
- Corporation ("Maintainers") the author, the license condition, and
- the name of such third parties' programs.
+* http://www.gnu.org/licenses/gpl-2.0.html