ukaea / paramak

Create parametric 3D fusion reactor CAD models
https://paramak.readthedocs.io/en/main/
36 stars 12 forks source link

removed duplicate parts that are in the readthedocs #814

Closed shimwell closed 3 years ago

shimwell commented 3 years ago

Proposed changes

Along the same lines as #807 this PR is another option for removing the maintainace of the README.md file but simply removing all the duplication. What do you think @RemDelaporteMathurin

Types of changes

Checklist

shimwell commented 3 years ago

Shall I add the "Getting started" section to the read the docs or the README.md.

I think that having zero examples in the readme will steer users to the documentation, so perhaps I can add a getting started section in the documentation