creativecommons / legaldb

CC Legal Database: curated repository of Case Law and Scholarship data from around the world in a Django based website.
https://LegalDB.CreativeCommons.org/
MIT License
44 stars 54 forks source link

Added Documentation For Cloning Code Into Your Machine or Code Editor. #168

Closed BalrajDhakad closed 7 months ago

BalrajDhakad commented 7 months ago

Fixes

Fixed issue #153

Description

I have added a step by step process on how a person can clone the repository or code into his or her machine or code editor using the web URL.

Screenshots

Added the following in Readme.md:

rectifiedFile

Checklist

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin ``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```
Xaid-vfx commented 7 months ago

@BalrajDhakad Great work!! but instead of providing such basic commands you should link to resources that covers all these dependencies

Read these comments by @TimidRobot in issue #153

For this kind of basic dependency, I think we should link to authoritative resources instead of copying portions of them.

For example, instead of providing instructions on cloning, etc., a repository from GitHub, we should link to GitHub's beginner documentation. I imagine a Development Dependencies section with a short list of links.