Skip to content

Commit 3ea67e9

Browse files
authored
Merge pull request #38 from VTTI-CSM/main
update Readme
2 parents c9f9417 + 4bd03a3 commit 3ea67e9

3 files changed

Lines changed: 65 additions & 3 deletions

File tree

.all-contributorsrc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"files": [
3+
"README.md"
4+
],
5+
"imageSize": 100,
6+
"commit": false,
7+
"commitType": "docs",
8+
"commitConvention": "angular",
9+
"contributors": [
10+
{
11+
"login": "heshamrakha",
12+
"name": "Hesham Rakha",
13+
"avatar_url": "https://avatars.githubusercontent.com/u/11538915?v=4",
14+
"profile": "https://github.com/heshamrakha",
15+
"contributions": [
16+
"projectManagement"
17+
]
18+
},
19+
{
20+
"login": "ahmedaredah",
21+
"name": "Ahmed Aredah",
22+
"avatar_url": "https://avatars.githubusercontent.com/u/77444744?v=4",
23+
"profile": "https://github.com/AhmedAredah",
24+
"contributions": [
25+
"code"
26+
]
27+
}
28+
],
29+
"contributorsPerLine": 7,
30+
"skipCi": true,
31+
"repoType": "github",
32+
"repoHost": "https://github.com",
33+
"projectName": "NeTrainSim",
34+
"projectOwner": "VTTI-CSM"
35+
}

LICENSE

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -631,8 +631,9 @@ to attach them to the start of each source file to most effectively
631631
state the exclusion of warranty; and each file should have at least
632632
the "copyright" line and a pointer to where the full notice is found.
633633

634-
<one line to give the program's name and a brief idea of what it does.>
635-
Copyright (C) <year> <name of author>
634+
NeTrainSim: An open-source freight rail energy and emissions simulation
635+
engine for modeling train movement dynamics and rail network operations.
636+
Copyright (C) 2025 Ahmed Aredah and Hesham Rakha
636637

637638
This program is free software: you can redistribute it and/or modify
638639
it under the terms of the GNU General Public License as published by
@@ -652,7 +653,7 @@ Also add information on how to contact you by electronic and paper mail.
652653
If the program does terminal interaction, make it output a short
653654
notice like this when it starts in an interactive mode:
654655

655-
<program> Copyright (C) <year> <name of author>
656+
NeTrainSim Copyright (C) 2025 Ahmed Aredah and Hesham Rakha
656657
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657658
This is free software, and you are welcome to redistribute it
658659
under certain conditions; type `show c' for details.

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,24 @@
2323
</a>
2424
</p>
2525

26+
<div align="center">
27+
28+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
29+
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
30+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
31+
32+
</div>
33+
2634
<p align="center">
2735
<a href="https://github.com/VTTI-CSM/NeTrainSim/releases" target="_blank">Download NeTrainSim</a> |
2836
<a href="https://youtu.be/bbvnPn9zMsQ" target="_blank">How to Install and Quick Overview</a> |
2937
<a href="https://VTTI-CSM.github.io/NeTrainSim/" target="_blank">Documentation</a> |
3038
<a href="https://join.slack.com/t/netrainsim/shared_invite/zt-2913nksde-mmvbGCdz8k8GgjdfeQBXZQ" target="_blank">Slack</a>
3139
</p>
3240

41+
42+
43+
3344
# Network Train Simulator (NeTrainSim)
3445

3546
NeTrainSim is an open-source train simulation software that allows users to simulate and analyse train operations on a large rail network. It is designed to be flexible, modular, and easy to use. It is built using Qt6 under the [GNU General Public License (GPL) version 3](https://www.gnu.org/licenses/gpl-3.0.en.html).
@@ -175,6 +186,21 @@ The development of NeTrainSim has been a collaborative effort. The following ind
175186
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
176187
<!-- prettier-ignore-start -->
177188
<!-- markdownlint-disable -->
189+
<table>
190+
<tbody>
191+
<tr>
192+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/heshamrakha"><img src="https://avatars.githubusercontent.com/u/11538915?v=4?s=100" width="100px;" alt="Hesham Rakha"/><br /><sub><b>Hesham Rakha</b></sub></a><br /><a href="#projectManagement-heshamrakha" title="Project Management">📆</a></td>
193+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/AhmedAredah"><img src="https://avatars.githubusercontent.com/u/77444744?v=4?s=100" width="100px;" alt="Ahmed Aredah"/><br /><sub><b>Ahmed Aredah</b></sub></a><br /><a href="https://github.com/VTTI-CSM/NeTrainSim/commits?author=ahmedaredah" title="Code">💻</a></td>
194+
</tr>
195+
</tbody>
196+
</table>
197+
198+
<!-- markdownlint-restore -->
199+
<!-- prettier-ignore-end -->
200+
201+
<!-- ALL-CONTRIBUTORS-LIST:END -->
202+
<!-- prettier-ignore-start -->
203+
<!-- markdownlint-disable -->
178204

179205
<!-- markdownlint-restore -->
180206
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)