gramaziokohler / compas_timber

https://gramaziokohler.github.io/compas_timber/

MIT License

18 stars 25 forks source link

Checklist - opening to public #102

Open funkchaser opened 1 year ago

funkchaser commented 1 year ago

Check-list

TODOs for making compas_timber public by 16th May 2023:

[ ] documentation / API:
- [x] consistent highlighting (e.g. COMPAS TIMBER/compas_timber, Beam/beam/Beam etc..)
- [ ] complete and check docstrings
- [x] complete and check grasshopper tutorial
- [x] add examples to download
- [ ] update quick installation guide & create downloads
- [ ] clean up README on the main repo page
- [ ] add link to API to README
[ ] sort out github actions for proper release
[x] close stale issues
[x] delete stale branches
[x] delete branch main rename dev to main
[ ] check permissions after public
[ ] register a DOI (for citations)
[ ] GKR website
[ ] link with compas extensions?

funkchaser commented 1 year ago

constistent highlighting:

tbd:

package name: COMPAS TIMBER
object class names:
rst:
```
:code:`Beam`
```
arguments or attribute names mentioned in text: italic
rst:
```
`looks_like_italic`
```