Skip to content

Commit 7b9a48d

Browse files
Docs cleanup (#1736)
* Remove roadmap * Create workplane.rst * Add text * Restructure primer.rst * Create citing.rst * Add citing to index.rst * Update README.md Mention citing * Add citation.cff * Delete citation.cff.yaml * Create CITATION.cff * Update CITATION.cff * Update CITATION.cff * Update CITATION.cff * Update CITATION.cff * Apply suggestions from code review Co-authored-by: Jeremy Wright <[email protected]> * Add refs * tweak --------- Co-authored-by: Jeremy Wright <[email protected]>
1 parent 0ebfa2b commit 7b9a48d

File tree

6 files changed

+582
-553
lines changed

6 files changed

+582
-553
lines changed

CITATION.cff

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
cff-version: 1.2.0
2+
doi: 10.5281/zenodo.10513848
3+
license: "Apache 2.0"
4+
url: https://github.com/CadQuery/cadquery
5+
title: "CadQuery"
6+
message: "If you use this software, please cite it using these metadata."
7+
authors:
8+
- name: "CadQuery contributors"

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55
[![Build Status](https://dev.azure.com/cadquery/conda-packages/_apis/build/status/CadQuery.cadquery?branchName=master)](https://dev.azure.com/cadquery/conda-packages/_build/latest?definitionId=2&branchName=master)
66
[![codecov](https://codecov.io/gh/CadQuery/cadquery/branch/master/graph/badge.svg)](https://codecov.io/gh/CadQuery/cadquery)
77
[![Documentation Status](https://readthedocs.org/projects/cadquery/badge/?version=latest)](https://cadquery.readthedocs.io/en/latest/?badge=latest)
8-
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4498634.svg)](https://doi.org/10.5281/zenodo.4498634)
9-
8+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4498634.svg)](https://doi.org/10.5281/zenodo.3955118)
109

1110
---
1211

@@ -230,3 +229,7 @@ When filing a bug report [issue](https://github.com/CadQuery/cadquery/issues), p
230229
### How to Suggest a Feature or Enhancement
231230

232231
If you find yourself wishing for a feature that does not exist, you are probably not alone. There are bound to be others out there with similar needs. Open an [issue](https://github.com/CadQuery/cadquery/issues) which describes the feature you would like to see, why you need it, and how it should work.
232+
233+
## Citing
234+
235+
Please use our Zenodo DOI if you use CadQuery for scientific research: https://doi.org/10.5281/zenodo.3955118.

doc/citing.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Citing
2+
======
3+
4+
Please use our Zenodo DOI if you use CadQuery for scientific research: https://doi.org/10.5281/zenodo.3955118.

doc/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Table Of Contents
3838
quickstart.rst
3939
designprinciples.rst
4040
primer.rst
41+
workplane.rst
4142
sketch.rst
4243
assy.rst
4344
free-func.rst
@@ -51,7 +52,7 @@ Table Of Contents
5152
importexport.rst
5253
cqgi.rst
5354
extending.rst
54-
roadmap.rst
55+
citing.rst
5556

5657

5758

0 commit comments

Comments
 (0)