Welcome to the PLC Simulator Online Documentation Project! This project aims to create comprehensive, user-friendly documentation for our open-source PLC simulator.
This documentation is intended to serve as a complete guide for users and contributors to the PLC simulator. We aim to provide clear, concise information and tutorials to assist with using the simulator to its full potential.
We welcome and encourage contributions from the community! Whether you're correcting a typo, adding a new section, or improving existing content, your contribution can make a significant difference.
Here are the steps you can follow to contribute:
-
Fork the Repository: Click on the 'Fork' button at the top right corner of this page and clone the forked repository on your local machine.
-
Create a New Branch: Use the
git checkout -b branch-namecommand to create a new branch. Please choose the branch name that describes your modification. -
Make Your Changes: Make the changes you want to contribute. These could be adding new content, modifying existing content, or fixing errors.
-
Commit Your Changes: Commit the changes with
git commit -m "Commit message". Write a clear and concise commit message describing what you have modified or added. -
Push to GitHub: Push your commits using
git push origin branch-name. -
Submit a Pull Request: Go to your repository on GitHub, and click the 'Compare & pull request' button next to your branch. Review your changes and submit the pull request.
Even though the source code of our main project, plc-simulator, is not public, we value and greatly appreciate feedback, bug reports, and feature requests from our users. We use the plc-simulator-docs repository as a hub for this purpose.
Please use the Issues section of this plc-simulator-docs repository to report any problems you encounter or to request new features. Here's how you can do that:
- Navigate to the Issues tab of the
plc-simulator-docsrepository. - Click on the New issue button.
- Write a descriptive title and provide as much detail as possible in the body of the issue. If you're reporting a bug, include steps to reproduce the bug, the expected behavior, and the actual behavior. If you're requesting a feature, describe the feature, why you think it would be useful, and how you imagine it might work.
- Click on Submit new issue.
Our development team monitors the issues here regularly, and we'll do our best to address your bug reports and feature requests in a timely manner. You're also welcome to contribute to discussions on existing issues.
Thank you for helping us improve the plc-simulator!
This project is licensed under MIT License.
If you have any questions, feel free to contact us at email.
We're excited to see your contributions!