Revision 083322a2 README.md

View differences:

README.md
3 3

  
4 4
*The best way to emulate almost any network on your laptop!*
5 5

  
6
Version 2.1.0+
6
Version 2.2b0
7 7

  
8 8
### What is Mininet?
9 9

  
......
66 66

  
67 67
  `mn -c`
68 68

  
69
### New features in 2.1.0+
69
### New features in 2.2b0
70 70

  
71
Mininet 2.1.0+ provides a number of bug fixes as well as
71
Mininet 2.2b0 provides a number of bug fixes as well as
72 72
several new features, including:
73 73

  
74
* Convenient access to `Mininet()` as a dict of nodes
75
* X11 tunneling (wireshark in Mininet hosts, finally!)
76
* Accurate reflection of the `Mininet()` object in the CLI
77
* Automatically detecting and adjusting resource limits
78
* Automatic cleanup on failure of the `mn` command
79
* Preliminary support for running OVS in user space mode
80
* Preliminary support (`IVSSwitch()`) for the Indigo Virtual Switch
81
* support for installing the OpenFlow 1.3 versions of the reference
82
  user switch and NOX from CPqD
83
* The ability to import modules from `mininet.examples`
74
* Improved OpenFlow 1.3 support
84 75

  
85
We have provided several new examples (which can easily be
86
imported to provide useful functionality) including:
76
	- `mn --switch ovs,protocols=openflow13` starts OVS in 1.3 mode
77
	- `install.sh -w` installs 1.3-compatible Wireshark dissector using
78
	  Loxigen
79
	- `install.sh -y` installs Ryu 1.3-compatible controller
87 80

  
88
* Modeling separate control and data networks: `mininet.examples.controlnet`
89
* Connecting Mininet hosts the internet (or a LAN) using NAT: `mininet.examples.nat`
90
* Creating per-host custom directories using bind mounts: `mininet.examples.bind`
81
* A new `nodelib.py` node library, and new `Node` types including
82
  `LinuxBridge`, `OVSBridge`, `LinuxRouter` and `NAT`
83

  
84
* An improved MiniEdit GUI (`examples/miniedit.py`) - thanks to
85
  Gregory Gee
86

  
87
* Experimental cluster support - consult the documentation for details,
88
  as well as `examples/cluster.py` and an experimental `--cluster`
89
  option for topologies built with the default `Host` and `OVSSwitch`
90
  classes:
91

  
92
  `mn --cluster localhost,server1,server2`
93

  
94
[1] http://docs.mininet.org
91 95

  
92 96
Note that examples contain experimental features which might
93 97
"graduate" into mainline Mininet in the future, but they should 
......
113 117

  
114 118
<https://mailman.stanford.edu/mailman/listinfo/mininet-discuss>
115 119

  
116
### Contributing
120
### Join Us
117 121

  
118 122
Mininet is an open source project and is currently hosted
119 123
at <https://github.com/mininet>.  You are encouraged to download
120 124
the code, examine it, modify it, and submit bug reports, bug fixes,
121 125
feature requests, new features and other issues and pull requests.
122
Thanks to everyone who has contributed to the project
123
(see CONTRIBUTORS for more info!)
126
Thanks to everyone who has contributed code to the Mininet project
127
(see CONTRIBUTORS for more info!) It is because of everyone's
128
hard work that Mininet continues to grow and improve.
129

  
130
### Enjoy Mininet
124 131

  
125 132
Best wishes, and we look forward to seeing what you can do with
126 133
Mininet to change the networking world!
127 134

  
128
### Credits
129

  
130
The Mininet 2.1.0+ Team:
135
The Mininet 2.2b0 Core Team:
131 136

  
132 137
* Bob Lantz
133 138
* Brian O'Connor
139
* Cody Burkard
140

  
141
Thanks again to all of the Mininet contributors, particularly Gregory
142
Gee for his work on MiniEdit.
143

  

Also available in: Unified diff