ubsuny / CP1-24-HW1

Homework template for CP1 in 2024
1 stars 17 forks source link

Restructure READ.ME #25

Open laserlab opened 1 week ago

laserlab commented 1 week ago

Readme should be a file about the project and not the homework description. Rename the original readme and start a new one with an overview of the project.

ojha-aditya commented 1 week ago

So the original readme file needs to be renamed as the Homework Description and the new readme file should contain a description of Bell's inequality and its qiskit implementation?

Also how is adding/uploading files to the code page of a repository different than a pull request? Will split this into a separate issue, maybe someone else also has the same doubt.

laserlab commented 1 week ago

This is not different from a pull request. Also the new readme should not necessarily include the physics documentation but can also link to it