Update readme

This commit is contained in:
adam-urbanczyk
2019-02-16 22:48:20 +01:00
parent b8b0975ef5
commit 3a60c09035

View File

@ -1,12 +1,69 @@
# CadQuery - add logo
[![Travis Build Status](https://travis-ci.org/CadQuery/cadquery.svg?branch=master)](https://travis-ci.org/CadQuery/cadquery.svg?branch=master)
[![Appveyor Build status](https://ci.appveyor.com/api/projects/status/cf4qg6kpyqmcje1h?svg=true)](https://ci.appveyor.com/api/projects/status/cf4qg6kpyqmcje1h?svg=true)
[![codecov](https://codecov.io/gh/CadQuery/cadquery/branch/master/graph/badge.svg)](https://codecov.io/gh/CadQuery/cadquery)
## What is CadQuery
This is an experimental CadQuery fork that uses PythonOCC instead of FreeCAD. It also has preliminary Jupyter notebook integration.
CadQuery is an intuitive, easy-to-use python module for building parametric 3D CAD models. Using CadQuery, you can write short, simple scripts that produce high quality CAD models. It is easy to make many different objects using a single script that can be customized.
You can try it out on linux-64, osx-64 and win-64 using conda:
PLACEHOLDER (something about OPENCASCADE and its capabilities and why is it so much better than OpenSCAD / CGAL).
### Features
* Build 3d models with scripts that are as close as possible to how you'd describe the object to a human.
* Create parametric models that can be very easily customized by end users
* Output high quality (loss-less) CAD formats like STEP in addition to STL and AMF
* Provide a non-proprietary, plain text model format that can be edited and executed with only a web browser
* PLACEHOLDER - something about advanced modeling capbilities: fillets, extrudes, lofts
### Why this fork
PLACEHOLDER
## Getting started
It is currently possible to use CadQuery for your own projects in 4 different ways:
* using CQ editor GUI
* from a Jupyter notebook
* using a Docker image [is this still supported?]
* as a standalone library
The easiest way to install CadQuery and its dependancies is using conda:
```
conda install -c pythonocc -c oce -c conda-forge -c dlr-sc -c CadQuery cadquery-occ
conda install -c conda-forge -c cadquery cadquery
```
PLACEHOLDER - maybe mention the conda-packages repo for interested readers.
### GUI
PLACEHOLDER - link, install instruction, screenshot
### Jupyter
PLACEHOLDER - mention that CQ supports rendering in a jupyter notebook out of the box
### Docker
PLACEHOLDER -
### Standalone
PLACEHOLDER
## Getting help
PLACEHOLDER: link to docs and google group
## Projects using cadquery
I'd keep this shorter
## License
Apache 2.0 blabla
## Contributing
We need your help...