proofread using llm

Author: avarga

BugTracker.md

@@ -11,9 +11,9 @@ The INET project uses the GitHub issue tracker at **https://github.com/inet-fram
 </ul>
 
 To report a bug or suggest an enhancement, log in with your GitHub username, and click *New issue*.
-Before submitting the bug report, please check that the problem was not reported before by someone else.
+Before submitting the bug report, please check if the problem has been reported by someone else.
 
-If you haven't submitted a bug report before, please read the following pages carefully:
+If you have not submitted a bug report before, please read the following pages carefully:
 
 *   [Bug Writing Guidelines][2]{:target="_blank"}
 *   [How to Report Bugs Effectively][3]{:target="_blank"}

CodingConventions.md

@@ -8,7 +8,7 @@ underMenu: Development
 
 We know that indentation style is a personal matter but the codebase needs to look consistent, so please adhere to the conventions below.
 
-*   Bracket style: largely Stroustrup (Egyptian braces), except for classes, functions and the like where we prefer to place the opening braces on a new line
+*   Bracket style: largely Stroustrup (Egyptian braces), except for classes, functions, and the like where we prefer to place the opening braces on a new line
 *   4-space indentation, NO TAB CHARACTERS, no trailing spaces
 *   Do not align variable names in declaration blocks or multi-line function declarations. They are hard to maintain,
     and look awkward when very short and very long type names are mixed (e.g. `int` vs `const std::vector<SomeVeryLongTypeName>&`).
@@ -23,11 +23,11 @@ Choose *OMNeT++* as your code style. Pressing <kbd>Ctrl+Shift+F</kbd> will refor
 
 ## Naming Convention
 
-Rules for variable names, function names, class names and other identifiers.
+Rules for variable names, function names, class names, and other identifiers.
 
 *   Use camel case
-*   Variables and functions start with lower case
-*   Types start with upper case
+*   Variables and functions start with lowercase
+*   Types start with uppercase
 *   Constants and enum values are capitalized, with underscore as word separator
 *   Don't abbreviate (too much)
 *   Function names start with a verb
@@ -53,14 +53,14 @@ Consistent layout of class declarations throughout the project helps maintainers
 
 ## Functions
 
-Misnamed and "kitchen-sink" functions are unfortunately quite common, and make the code hard to follow and reason about. Here's what you can do:
+Misnamed and "kitchen-sink" functions are unfortunately quite common and make the code hard to follow and reason about. Here's what you can do:
 
 *   Functions should be focused (i.e. do one thing only), and the name should reflect the purpose
 *   Try to minimize side effects (modify class members and other non-local state as little as possible)
-*   If you cannot find an accurate name for it, it is a strong indicator that the function should not exist in that form (e.g. needs to be split up, or the code organized in a different way)
+*   If you cannot find an accurate name for it, it is a strong indicator that the function should not exist in that form (e.g. needs to be split up or the code organized in a different way)
 *   If it has a side effect, the name should reflect that (e.g. *get* methods must not modify state)
 *   Local variables should be declared close to their use, in the smallest scope possible (i.e. not C-style, at the top of the function)
-*   Commenting: we prefer breaking up the function body into logical blocks, and adding a `//` comment above each block to document its intended *purpose*
+*   Commenting: we prefer breaking up the function body into logical blocks and adding a `//` comment above each block to document its intended *purpose*
 
 ## C++ Style
 

CommunityCoordinators.md

@@ -16,22 +16,20 @@ We see two general directions:
 
 ## Improve Publicity
 
-We'd like to have more, more up to date, and higher quality information to be available about the INET Framework.
+We'd like to have more, more up-to-date, and higher quality information available about the INET Framework.
 
-*   keep the INET web site up to date with new information
-*   regularly collect progress information from INET developers/contributors, and disseminate it over various channels (mailing list, twitter, etc.)
-*   collect and organize teaching materials
-*   collect third-party tutorials, demos, related projects
+*   Keep the INET website up-to-date with new information
+*   Regularly collect progress information from INET developers/contributors and disseminate it over various channels (mailing list, Twitter, etc.)
+*   Collect and organize teaching materials
+*   Collect third-party tutorials, demos, and related projects
 
 ## Harness the Potential of the Community
 
-We see a great potential in the user community of the INET Framework. We have several people in the community with extensive knowledge on specific areas of computer networks, and there are many who are willing to contribute to INET as an open-source project. We'd like to achieve that people who have the knowledge and willingness to contribute to INET have an easier job to find ways to connect.
+We see great potential in the user community of the INET Framework. We have several people in the community with extensive knowledge in specific areas of computer networks, and there are many who are willing to contribute to INET as an open-source project. We'd like to make it easier for people with knowledge and willingness to contribute to INET to find ways to connect.
 
-*   find [advisors](ComponentAdvisors.html) for various INET components
-*   collect feedback on issues and priorities of the user community
-*   look for potential contributions (third-party projects, papers with INET-based simulations, etc.)
-*   collect and advertise masters thesis topics that could result in contributions
-*   work out and operate a bounty system
-
-Tools: email, web, social media
+*   Find [advisors](ComponentAdvisors.html) for various INET components
+*   Collect feedback on issues and priorities of the user community
+*   Look for potential contributions (third-party projects, papers with INET-based simulations, etc.)
+*   Collect and advertise master's thesis topics that could result in contributions
+*   Work out and operate a bounty system
 

ContribGettingStarted.md

@@ -10,7 +10,7 @@ INET is developed using the *git* revision control system, with the repository h
 
 <div class="alert alert-info">
 {% capture tmp %}
-**New to git?** Read about it on its [web site](http://git-scm.com){:target="_blank"},
+**New to git?** Read about it on its [website](http://git-scm.com){:target="_blank"},
 from the [GitHub help](https://help.github.com/articles/good-resources-for-learning-git-and-github/){:target="_blank"},
 or [try it hands-on in a terminal](http://try.github.com/){:target="_blank"}.
 {% endcapture %} {{ tmp | markdownify }}
@@ -21,22 +21,21 @@ We recommend the following workflow:
 1.  Create an account on GitHub, and fork the INET project to create your
     own version. Clone the new repository to your computer.
 
-2.  Create a new topic branch for your changes, by branching the `master` (stable)
-    branch.
+2.  Create a new topic branch for your changes by branching the `master` (stable) branch.
 
     <div class="alert alert-warning">
     <b>Note:</b> It is NOT safe to start off from an existing topic branch.
     Topic branches should be considered a private playing field of the person
-    who created them, and may be deleted, rebased, or their history rewritten
+    who created them and may be deleted, rebased, or have their history rewritten
     at any time. If a topic (or attic) branch looks interesting to you, contact
-    the person who works in that branch -- don't assume anything without asking.
+    the person who works in that branch — don't assume anything without asking.
     </div>
 
 3.  Commit your changes into your topic branch.
 
-    *  We recommend that you pull from the INET repository from time to time,
+    *  We recommend that you pull from the INET repository from time to time
        and rebase your topic branch to the tip of the `master` branch.
-    *  Try to keep to the coding conventions of the INET Framework. If you implement
+    *  Try to adhere to the coding conventions of the INET Framework. If you implement
        a new component, you can take inspiration from existing parts of the framework.
     *  If you have questions or something to discuss, don't hesitate to post to the mailing list.
 

ContributionIdeas.md

@@ -4,24 +4,23 @@ title: Contribution Ideas
 underMenu: Contributing
 ---
 
-Let us give you some hints what you can work on. Further ideas are also welcome.
+Let us give you some hints on what you can work on. Further ideas are also welcome.
 
 ### Code
 
-If you are interested, please contact us so we can discuss the details,
-and avoid possible duplication of work.
+If you are interested, please contact us so we can discuss the details and avoid possible duplication of work.
 
 * Improve IPv6 support
 * Refine MPLS and RSVP-TE
 * Revise HttpTools
-* SIP
-* TLS
+* Work on SIP
+* Work on TLS
 * ...
 
 ### Other
 
-* A Tictoc-like tutorial for INET (or several tutorials, specialized for different kinds of networks)
-* Tutorial or demo videos (preferably with narration)
+* Create a Tictoc-like tutorial for INET (or several tutorials specialized for different kinds of networks)
+* Create tutorial or demo videos (preferably with narration)
 * Put together well-thought-out example simulations
 * ...
 

DocumentationGuidelines.md

@@ -8,25 +8,25 @@ We maintain documentation in the following forms:
 
 *   **INET Framework User's Guide** is meant to provide information for users who want to assemble new models from pre-existing components. It provides an overview of the components and architecture of the framework.
 *   **INET Framework Developer's Guide** is meant to provide information for the developers who intend to extend INET with new components, written in C++.
-*   **INET Reference**, built from NED and C++ source, provides cross-linked, browsable reference information about the modules and classes of the implementation
+*   **INET Reference**, built from NED and C++ source, provides cross-linked, browsable reference information about the modules and classes of the implementation.
 
 The following auxiliary files are managed by the core INET maintainers:
 
-*   **ChangeLogs**. Every source folder contains a `ChangeLog` file in a fixed format. ChangeLogs exist so that users can get a high level overview of the history of that component. It is usually derived from the git log by heavy editing for conciseness and clarity, e.g. by combining a series of related commit messages into a single change summary. (The git log is often too detailed and contains too much "noise" for end-user consumption.)
-*   **WHATSNEW** (in the project root directory) is updated before each release, and contains a summary of changes in the whole framework.
+*   **ChangeLogs**. Every source folder contains a `ChangeLog` file in a fixed format. ChangeLogs exist so that users can get a high-level overview of the history of that component. It is usually derived from the git log by heavy editing for conciseness and clarity, e.g. by combining a series of related commit messages into a single change summary. (The git log is often too detailed and contains too much "noise" for end-user consumption.)
+*   **WHATSNEW** (in the project root directory) is updated before each release and contains a summary of changes in the whole framework.
 *   **AUTHORS** (in the project root directory) records the names of those who contributed to the project. The [Contributors](/Contributors.html) page should always contain a mirror of this file.
 
 ## INET User's Guide and Developer's Guide
 
 Technically:
 
 *   Sources are in the repository under [doc/src/users-guide][2] and [doc/src/developers-guide][3], in RestructuredText.
-*   PDF and/or HTML are built by the release manager for each release
+*   PDF and/or HTML are built by the release manager for each release.
 
 Content and level of detail:
 
-*   The purpose of the User's Guide is to provide an overview of INET, and provide high-level information about every implemented protocol model or component, potentially including practical advice on how to use them or combine them with other models.
-*   The purpose of the Developer's Guide is to help users and contributors who want to understand the internal architechure and mechanisms of INET, and wish to extend it with new components, written in C++.
+*   The purpose of the User's Guide is to provide an overview of INET and provide high-level information about every implemented protocol model or component, potentially including practical advice on how to use them or combine them with other models.
+*   The purpose of the Developer's Guide is to help users and contributors who want to understand the internal architecture and mechanisms of INET and wish to extend it with new components, written in C++.
 *   Must not duplicate information in protocol standards, in the INET Reference, etc.
 
 If you wish to contribute, please check the **Authors Guide** chapters in both documents to see what kind of content is expected before writing anything.
@@ -39,7 +39,7 @@ NED documentation:
 
 *   We use explicit hyperlinks, i.e. the tilde notation is necessary to create a hyperlink to other modules. Examples: `the ~TCP module` (hyperlinks the TCP module), but: `the TCP protocol` (no hyperlink).
 *   NED comments document the external interface: purpose, standards compliance, parametrization, gates, etc.
-*   Provide a reference to the protocol specification, and also describe what parts of the specification are implemented and what parts are missing.
+*   Provide a reference to the protocol specification and also describe what parts of the specification are implemented and what parts are missing.
 
 C++ documentation:
 

Extensions.md

@@ -10,11 +10,11 @@ There are several INET-based model frameworks, maintained by independent researc
 
 *   [Veins](http://veins.car2x.org/){:target="_blank"} is an open source Inter-Vehicular Communication (IVC) simulation framework composed of an event-based network simulator and a road traffic microsimulation model.
 
-*   [SimuLTE](http://github.com/inet-framework/simulte){:target="_blank"} is LTE user plane simulation model, with eNodeB and UE models.
+*   [SimuLTE](http://github.com/inet-framework/simulte){:target="_blank"} is an LTE user plane simulation model, with eNodeB and UE models.
 
-*   [INETMANET](http://github.com/aarizaq/inetmanet-2.0){:target="_blank"} is fork of INET with experimental features related to mobile and ad-hoc networks.
+*   [INETMANET](http://github.com/aarizaq/inetmanet-2.0){:target="_blank"} is a fork of INET with experimental features related to mobile and ad-hoc networks.
 
-*   [MiXiM](https://github.com/omnetpp/mixim){:target="_blank"} is not an INET extension, but an independent OMNeT++ modeling framework that focuses on the wireless physical, data link and networ layers. MiXiM can be used together with INET. Newer versions of INET (from 2.99.0 up) have the features of MiXiM, and much of the MiXiM code integrated.
+*   [MiXiM](https://github.com/omnetpp/mixim){:target="_blank"} is not an INET extension, but an independent OMNeT++ modeling framework that focuses on the wireless physical, data link and network layers. MiXiM can be used together with INET. Newer versions of INET (from 2.99.0 up) have the features of MiXiM, and much of the MiXiM code integrated.
 
 *   The [Vehicular Networks and Distributed Control Systems](http://vehicular.omnetpp.org){:target="_blank"} page lists extensions related to the automotive industry.
 

GettingStarted.md

@@ -8,14 +8,14 @@ Here are some things you can do after having installed INET successfully.
 
 ### Try Some Example Simulations
 
-Find the `inet` project in the IDE workspace, and explore it.
-Sources of protocol implementations and other components are in the `src/` folder.
+Find the `inet` project in the IDE workspace and explore it.
+The sources of protocol implementations and other components are in the `src/` folder.
 The `examples/` folder contains several example simulation models, that is,
 networks assembled from components under `src/`.
 
-You can launch an example simulation by selecting its folder, and clicking *Run*
+You can launch an example simulation by selecting its folder and clicking *Run*
 on the toolbar. The simulation will execute as a GUI application, letting you
-explore, run, pause, and single-step the simulation model. Simulation results
+explore, run, pause, and single-step the simulation model. The simulation results
 will be placed into the `results/` subfolder; you can view them by
 double-clicking the created `vec` or `sca` files.
 
@@ -26,14 +26,14 @@ pages, each about 5-10 minutes to read, are automatically opened in the IDE
 when you first start it. You can also access them later from the *Help* menu
 (*Help Contents -> OMNeT++ Documentation -> Getting Started*).
 
-* **OMNeT++ at a Glance**: explains the purpose of various files: `ini`, `ned`, `msg` and so on.
+* **OMNeT++ at a Glance**: explains the purpose of various files: `ini`, `ned`, `msg`, and so on.
 
 * **Getting Started with the Simulation IDE**: an illustrated guide to performing basic tasks in the IDE.
 
 Then, we strongly recommend that you go through the basic tutorial that comes with OMNeT++.
 It will take more than a few minutes, but it's the quickest way to get you going.
 
-* **Tictoc tutorial**. It consists of steps that start from a very simple simulation model
+* **Tictoc tutorial**: It consists of steps that start from a very simple simulation model
   and progressively makes it more complex, introducing you to new functionality along the way.
 
 ### Follow the INET Tutorials
@@ -42,18 +42,18 @@ Follow the tutorials that come with the INET Framework.
 
 * [INET Tutorials](https://inet.omnetpp.org/docs/tutorials)
 
-Study the showcases that higlight how to use specific features in INET.
+Study the showcases that highlight how to use specific features in INET.
 
 * [INET Showcases](https://inet.omnetpp.org/docs/showcases)
 
 ### Modify Simulations or Create New Ones
 
 Armed with knowledge gained from experience in the previous steps, you should be
-able to modify the example simulations, or create simple new ones.
+able to modify the example simulations or create simple new ones.
 
 ### Learn More
 
-For more in-depth knowledge, e.g. to be able to understand and modify
+For more in-depth knowledge, e.g., to be able to understand and modify
 the components INET provides, you need to study the documentation.
 
 * [OMNeT++ User Manual](https://omnetpp.org/doc/omnetpp/manual)