Skip to content

Matty-Downing2169/opencamlib

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenCAMLib README

1. INTRODUCTION
OpenCAMLib (ocl) is a c++ library for creating toolpaths for cnc-machines
such as mills and lathes.

The project is hosted at
http://code.google.com/p/opencamlib/

The mailing-list for general development and user-discussion is:
http://groups.google.com/group/opencamlib

SVN commit messages go to a mailing-list:
http://groups.google.com/group/opencamlib-svn

IRC-channel #cam on irc.freenode.net

It's probably a good idea to try to adhere to some coding standard. Maybe this one:
http://www.possibility.com/Cpp/CppCodingStandard.html


2. BUILDING and INSTALLING (on unix/debian-like systems)
cd into the /src directory, then run
 $> cmake .
this creates a Makefile, and build with
 $> make 
this should create the ocl library as a file "ocl.so" in the /src directory
 $> sudo make install
will install the ocl.so library and camvtk.py so that any python shell will find them.

 
if you also want to build the documentation, then run
 $> make doc
and
 $> make doc-pdf
this should create the ocl manual named "ocl-manual.pdf" in the src/doc directory

using cmake and cpack it is possible to build a .deb package with
 $> make package

2.1 Out-of-source build
After downloading the source with svn, create a build directory
 $> mkdir bld
cd into the directory, and run cmake on ../src
 $> cd bld
 $> cmake ../src
now you can run "make", "make install", or "make package" in the /bld directory
which does not write .o files and other build-files into /src
The build directory /bld can be wiped clean ("rm -rf *") and cmake run again if/when you want a clean build.

3. ORGANIZATION OF FILES
(generate this with 'tree -dL 2')

├── cpp_examples                c++ example use of opencamlib
│   ├── cutsim1
│   ├── cutsim2
│   ├── point                   minimal example of ocl::Point
│   ├── qt_opengl
│   ├── qt_opengl_vbo
│   ├── qt_vbo2
│   ├── qt_vbo3
│   ├── qt_vtk_renderwindow
│   ├── renderwindowUI
│   └── vbo
├── debian                      files for building a debian package
├── doc                         documentation (not much here yet!)
├── lib                         useful python helper libraries
├── scripts                     python scripts that test or demonstrate use of ocl
│   ├── cutsim                  cutting simulation tests (old?)
│   ├── issues
│   ├── ocode                   old linear octree code
│   ├── offset-ellipse          relates to BullCutter drop- and push-cutter
│   ├── old
│   └── voronoi                 vd scripts/tests
├── src
│   ├── algo                    algorithms under development
│   ├── attic                   old deprecated code
│   ├── common                  common algorithms and data-structures
│   ├── cutsim                  cutting simulation
│   ├── cutters                 cutter-classes
│   ├── dropcutter              drop-cutter algorithms and operations
│   ├── geo                     primitive geometry classes (point,triangle,stlsurf, etc.)
│   └── voronoi
├── stl                         STL files for testing
└── Windows                     Visual-studio project for building on windows


the Id svn keyword is set like this:
svn propset svn:keywords 'Id' filename.cpp 


3. Ubuntu 10.04LTS-> install and build
- install 64-bit Ubuntu 10.04LTS
- run update manager and install all suggested updates. reboot.
- using synaptic or apt-get, install the following packages(and their dependencies)
-- build-essential
-- cmake
-- subversion
-- doxygen
-- texlive-latex-base
-- libboost1.40-all-dev
- checkout ocl from svn
-- instructions: http://code.google.com/p/opencamlib/source/checkout
- in the /src directory, first run "cmake ." then "make" and then "sudo make install"
-- this should build and install ocl correctly.


About

Automatically exported from code.google.com/p/opencamlib

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published