Skip to content

Commit 3d76f6b

Browse files
committed
improved and clean README
1 parent eca1591 commit 3d76f6b

File tree

2 files changed

+16
-24
lines changed

2 files changed

+16
-24
lines changed

DESCRIPTION.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ more accessible to new users.
1414
- Tutorial 7: Free energy calculation
1515
- Tutorial 8: Reactive Molecular Dynamics
1616

17-
## Files
17+
## Input files
1818

19-
All the files corresponding to the tutorials can be found in the
19+
All the input files from the tutorials can be found in the
2020
[**files/**](files/) folder. The Python scripts used to generate the plots
2121
are also provided.
2222

@@ -25,26 +25,22 @@ follow the tutorial. These files can be downloaded from the LAMMPS-GUI by
2525
selecting `Start Tutorial X`. The solutions to the tutorials are provided
2626
within the solution repository located in each tutorial folder.
2727

28-
## Link
29-
30-
https://github.com/lammpstutorials/lammpstutorials-article/actions/runs/12458522247/artifacts/2354075042
28+
## PDF
3129

3230
Access the last version of the `.pdf` from
33-
[the Actions tab](https://github.com/lammpstutorials/lammpstutorials-article/actions/runs/12458522247/artifacts/2354075042),
31+
[the Actions tab](https://github.com/lammpstutorials/lammpstutorials-article/actions/runs/12458522247/artifacts/2354075042) here on GitHub,
3432
or clone this repository and compile the `.tex` file yourself by typing in a terminal:
3533

3634
```
3735
make
3836
```
37+
This will generate the `.pdf` version of the tutorial. Ensure you have LaTeX and the necessary dependencies installed on your system before attempting to compile.
3938

4039
## Contributing
4140

42-
We welcome contributions. If you encounter any issues, have suggestions,
43-
or want to ask questions, please feel free to open an issue in this
44-
repository. Your feedback can help us improve the tutorials and make them
45-
more useful for everyone.
41+
We welcome contributions to improve the tutorials. If you encounter any issues, have suggestions, or want to ask questions, please open an issue in this repository. You can also contribute by submitting a pull request to improve the tutorials or fix any bugs.
42+
Your feedback and contributions help make the tutorials more useful for everyone.
4643

4744
## License
4845

49-
This project is licensed under the XXX License - see the
50-
[LICENSE](LICENSE) file for details.
46+
This project is licensed under the Creative Commons Attribution 4.0 International License. This license covers all the input [**files/**](files/) and tutorial content. For more details, see the [LICENSE](LICENSE) file.

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ more accessible to new users.
2323
- Tutorial 7: Free energy calculation
2424
- Tutorial 8: Reactive Molecular Dynamics
2525

26-
## Files
26+
## Input files
2727

28-
All the files corresponding to the tutorials can be found in the
28+
All the input files from the tutorials can be found in the
2929
[**files/**](files/) folder. The Python scripts used to generate the plots
3030
are also provided.
3131

@@ -34,29 +34,25 @@ follow the tutorial. These files can be downloaded from the LAMMPS-GUI by
3434
selecting `Start Tutorial X`. The solutions to the tutorials are provided
3535
within the solution repository located in each tutorial folder.
3636

37-
## Link
38-
39-
https://github.com/lammpstutorials/lammpstutorials-article/actions/runs/12458522247/artifacts/2354075042
37+
## PDF
4038

4139
Access the last version of the `.pdf` from
42-
[the Actions tab](https://github.com/lammpstutorials/lammpstutorials-article/actions/runs/12458522247/artifacts/2354075042),
40+
[the Actions tab](https://github.com/lammpstutorials/lammpstutorials-article/actions/runs/12458522247/artifacts/2354075042) here on GitHub,
4341
or clone this repository and compile the `.tex` file yourself by typing in a terminal:
4442

4543
```
4644
make
4745
```
46+
This will generate the `.pdf` version of the tutorial. Ensure you have LaTeX and the necessary dependencies installed on your system before attempting to compile.
4847

4948
## Contributing
5049

51-
We welcome contributions. If you encounter any issues, have suggestions,
52-
or want to ask questions, please feel free to open an issue in this
53-
repository. Your feedback can help us improve the tutorials and make them
54-
more useful for everyone.
50+
We welcome contributions to improve the tutorials. If you encounter any issues, have suggestions, or want to ask questions, please open an issue in this repository. You can also contribute by submitting a pull request to improve the tutorials or fix any bugs.
51+
Your feedback and contributions help make the tutorials more useful for everyone.
5552

5653
## License
5754

58-
This project is licensed under the XXX License - see the
59-
[LICENSE](LICENSE) file for details.
55+
This project is licensed under the Creative Commons Attribution 4.0 International License. This license covers all the input [**files/**](files/) and tutorial content. For more details, see the [LICENSE](LICENSE) file.
6056

6157
## Authors
6258

0 commit comments

Comments
 (0)