Merge branch 'release/5.2.3'

.editorconfig

@@ -0,0 +1,7 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = false
+
+[*.md]
+trim_trailing_whitespace = false

CMakeLists.txt

@@ -163,7 +163,7 @@ build_lib(
   TEST_SOURCES ${test_sources}
 )
 
-# Add BOFUSS dependecy to OFSwitch13 module
+# Add BOFUSS dependency to OFSwitch13 module
 if(NOT bofuss_FOUND AND NOT ${bofuss_FOUND})
   add_dependencies(${libofswitch13} bofuss_dep)
   if(NOT ${XCODE})

README.md

@@ -1,32 +1,34 @@
-# OpenFlow 1.3 module for ns-3 #
-This is the OFSwitch13 module, which enhances the [ns-3 Network Simulator][ns-3] with [OpenFlow 1.3][ofp13] capabilities, allowing ns-3 users to simulate Software-Defined Networks (SDN). In fact, this module implements the interface for interconnecting the ns-3 simulator to the [BOFUSS library][ofs13]. This library provides the switch implementation, the support for converting to/from OpenFlow 1.3 wire format, and the dpctl tool for configuring the switch from the console.
-
-Please, visit the [OFSwitch13 project homepage][project] for detailed information on the module design, documentation, and *how to get started* tutorials.
-The code API documentation for the latest release of this project is available [here][apidoc].
-
-# Contribute #
-Please, contribute to this project submitting your bug reports to the [issue tracker][issues]. For fixes and improvements, consider creating a pull request.
-
-# License #
-The OFSwitch13 module is free software, licensed under the [GNU GPLv2 license][gpl], and is publicly available for research, development, and use.
-
-# Acknowledgments #
-Thanks to the main contributors:
-
-* Luciano Jerez Chaves
-* Vítor Marge Eichemberger
-* Islene Calciolari Garcia
-* Arthur Boeacht Mazzi
-* *"Your name here"*
-
-# Contact #
-Feel free to subscribe to [our mailing list at Google groups][group] and provide some feedback, give us suggestions, interact with other users, or to just say hello!
-
-[ns-3]: https://www.nsnam.org
-[ofp13]: https://www.opennetworking.org/sdn-resources/technical-library
-[ofs13]: https://github.com/ljerezchaves/ofsoftswitch13
-[project]: http://www.lrc.ic.unicamp.br/ofswitch13/
-[apidoc]: http://www.lrc.ic.unicamp.br/ofswitch13/latest/doc/html/index.html
-[issues]: https://github.com/ljerezchaves/ofswitch13-module/issues
-[gpl]: http://www.gnu.org/copyleft/gpl.html
-[group]: https://groups.google.com/forum/#!forum/ofswitch13-users
+# OpenFlow 1.3 module for ns-3
+
+The OFSwitch13 module enhances the [ns-3 Network Simulator][ns-3] with Software-Defined Networking (SDN) capabilities.
+OFSwitch13 supports [OpenFlow protocol version 1.3][ofp13], bringing a switch device and a controller application interface to the ns-3 simulator.
+With OFSwitch13, it is possible to interconnect ns-3 nodes to send and receive traffic using the existing CSMA and virtual network devices.
+Extending the controller application interface allows users to implement any desired control logic to orchestrate the network.
+The communication between the controller and the switches happens over standard ns-3 protocol stack, devices, and channels.
+The OFSwitch13 module relies on the external [BOFUSS library][bofuss] that provides the switch datapath implementation and the support for OpenFlow messages in wire format.
+
+Please visit the [OFSwitch13 project homepage][project] and refer to the documentation for details about the module design, installation, and usage.
+
+## License
+
+The OFSwitch13 module is a free software licensed under the [GNU GPLv2 license][gpl].
+
+## Contribute
+
+The OFSwitch13 module is currently maintained by Luciano Jerez Chaves.
+It also received contributions from Vítor Marge Eichemberger, Islene Calciolari Garcia, Arthur Boechat Mazzi, and Pasquale Imputato.
+We thank Eder Leão Fernandes for helping with the BOFUSS library integration.
+
+Please contribute to this project by submitting your bug reports to the [issue tracker][issues]. For fixes and improvements, consider creating a pull request.
+
+## Contact
+
+Feel free to subscribe to the [mailing list at Google Groups][group] and provide feedback, give suggestions, interact with other users, or say hello!
+
+[ns-3]: https://www.nsnam.org
+[ofp13]: https://www.opennetworking.org/sdn-resources/technical-library
+[bofuss]: https://github.com/ljerezchaves/ofsoftswitch13
+[project]: http://www.lrc.ic.unicamp.br/ofswitch13/
+[issues]: https://github.com/ljerezchaves/ofswitch13-module/issues
+[gpl]: http://www.gnu.org/copyleft/gpl.html
+[group]: https://groups.google.com/forum/#!forum/ofswitch13-users