Coder Social home page Coder Social logo

freecad_mod_dev_guide's Introduction

Module developer's guide to FreeCAD source code

by Qingfeng Xia http://www.iesensor.com

  • 2015-09-18 version 0.1 for FreeCAD version 0.16-dev
  • 2016-09-18 version 0.2 for FreeCAD version 0.17-dev

License of this book

This ebook is licensed the same as FreeCAD document license CC-BY 3.0 http://creativecommons.org/licenses/by/3.0/

Acknowledge to developers of FreeCAD

Original/lead developers:

Add all contributors see http://www.freecadweb.org/wiki/index.php?title=Contributors

Target audiances: new module developers

Make sure you are familiar with FreeCAD workbench GUI and API as a user:

Doxygen documents links

Doxygen generated online documentation of source for 0.16dev

Why I want to write this book

  • Learn the software architecture of FreeCAD: a large open source project
  • Learn to use git to contribute to open source projects like FreeCAD
  • Save time for new developers to explore the source codde of FreeCAD
  • Record personal note and lesson during writing/contributing code to FreeCAD
  • Some chapters of this ebook is seeking to be merged into official wiki after reviewed as usable

Organisation of this book

  • Chapters are written in markdown and PDF is generated by pandoc
  • Python scripts to link Introduction to header files: *_folder_desc.py
  • Python script merge.py merges chapters into single md file then PDF

How to contribute to this ebook

  • write on unfinished topics/chapters listed in todo.md fork and pull request git clone https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide.git
  • file bug for outdated code analysis As this book is about code anlysis while FreeCAD is under heavy development, source codes quoted may outdated quickly. Please point out by report bugs in github

Acknowledgement to my family

Thanks for my wife Ms J. Wang, and other family members' consideration


freecad_mod_dev_guide's People

Contributors

qingfengxia avatar

Watchers

James Cloos avatar Victor avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.