suzanne.soy/Lattice2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source 
* links to Lattice wiki, FreeCAD forum, etc
* mention ParaSeries
This commit is contained in:
DeepSOIC 2015-12-31 17:46:02 +03:00
parent 1044740c79
commit 7d242eb2a0
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
readme.md
View File

@ -24,6 +24,8 @@ Let's have a glance over the most important capabilities that the workbench adds
* parametric explode commands allow extraction of specific elements of arrays, without losing parametric relation to the original.
* ParaSeries feature allows to generate a series of parts with some parameter varied over a list of values.
# Why Lattice2, not just Lattice?
Lattice2 was created at the moment when breaking changes needed to be made, but there were a few things made with Lattice. So, it was decided to keep the workbench in that time's state indefinitely as version 1.0, and start development of a new version.
@ -39,6 +41,8 @@ The goal was to be able to have both Lattice v1 and v2 in a single FreeCAD insta
* Lattice workbench can now be imported from Py console all at once, like that: `import Lattice2`
* ParaSeries feature was added, which can create a series of parts by changing some parameter of the model.
# Download/install
repository: https://github.com/DeepSOIC/Lattice2
@ -51,6 +55,16 @@ The workbench is OS independent, it should work on any system FreeCAD can be run
# License
Lattice workbench is licenced under LGPL V2, just like FreeCAD. For more info, see copying.lib file in the repository.
# Getting Help
Documentation: see [Lattice2 wiki](https://github.com/DeepSOIC/Lattice2/wiki) on Github. As "wiki" suggests, you can help by editing the documentation.
If you need help on something specific, you can ask a question on [FreeCAD forum](http://forum.freecadweb.org/index.php) (there is no Lattice forum yet...). You can also ask me directly.
If you have found a bug, report it [here, in Github's issue tracker for Lattice2](https://github.com/DeepSOIC/Lattice2/issues). You can also post ideas for new features there.
If you have fixed a bug, or implemented a new feature you think suits the workbench, or whatever - feel free to make a pull-request here on github.
# Status
This version is in devlopment. Breaking changes can be introduced at any point. If you want to make a project with use of Lattice workbench, it is recommended to stick with Lattice v1.