pull/292/head
Rob 2025-01-22 16:24:04 -05:00
rodzic 1b8b28fdd7
commit ebae0fbcac
3 zmienionych plików z 10 dodań i 10 usunięć

Wyświetl plik

@ -10,13 +10,13 @@ Fabex (formerly BlenderCAM) code can be broken down into categories:
5. Dependencies 5. Dependencies
Core Functions Core Functions
============== ****************
The core function of the Fabex addon is to take whatever object is in the viewport and generate toolpaths along that object according to a milling strategy set by the user. The core function of the Fabex addon is to take whatever object is in the viewport and generate toolpaths along that object according to a milling strategy set by the user.
These operations can be exported alone, or combined into chains to be exported and run together. These operations can be exported alone, or combined into chains to be exported and run together.
Extra Functions Extra Functions
=============== *****************
Beyond simply creating toolpaths for existing objects, Fabex can also create the objects (curves) and edit them through a number of operations. Beyond simply creating toolpaths for existing objects, Fabex can also create the objects (curves) and edit them through a number of operations.
There are modules dedicated to creating reliefs, joinery, puzzle joinery and gears. There are modules dedicated to creating reliefs, joinery, puzzle joinery and gears.
@ -24,19 +24,19 @@ There are modules dedicated to creating reliefs, joinery, puzzle joinery and gea
There is also a simulation module to allow a preview of what the final product will look like, as well as an asynchronous module that allows progress reports on calculations. There is also a simulation module to allow a preview of what the final product will look like, as well as an asynchronous module that allows progress reports on calculations.
Reference Files Reference Files
=============== ******************
Presets for machines, tools, operations and post-processors. Presets for machines, tools, operations and post-processors.
User Interface User Interface
============== ****************
Files related to Blender's UI - panels, menus, pie menus, popup dialogs etc. Files related to Blender's UI - panels, menus, pie menus, popup dialogs etc.
Dependencies Dependencies
============ ***************
Python wheels - executable binaries packed in for all supported systems. Python wheels - executable binaries packed in for all supported systems.
Complete Addon Layout Complete Addon Layout
--------------------- ***********************
:: ::

Wyświetl plik

@ -20,7 +20,7 @@ It will ensure that your spacing, indentation etc are in line with the project g
Most Code Editors/IDEs are able to integrate the Black formatter, so you can format your code while you work. Most Code Editors/IDEs are able to integrate the Black formatter, so you can format your code while you work.
Project Structure Project Structure
================= ******************
Fabex is a huge addon, with many different functions, added by many different contributors over the course of 12 years of development! Fabex is a huge addon, with many different functions, added by many different contributors over the course of 12 years of development!
In order to avoid conflicts, bugs and import errors a hierarchy has been established: In order to avoid conflicts, bugs and import errors a hierarchy has been established:

Wyświetl plik

@ -12,7 +12,7 @@ In the root folder of the repository, there is a folder called ``.github``, and
This folder contains a series of ``.yaml`` or ``.yml`` (either will work) files that describe what will trigger the workflow to start (e.g.: push, pull request etc), and which workflow file to run (e.g.: ``build_and_test.yaml``) This folder contains a series of ``.yaml`` or ``.yml`` (either will work) files that describe what will trigger the workflow to start (e.g.: push, pull request etc), and which workflow file to run (e.g.: ``build_and_test.yaml``)
Build and Test Build and Test
============== ****************
``build_and_test.yaml`` allows you to specify which version of Blender to build and test against, along with various other options. ``build_and_test.yaml`` allows you to specify which version of Blender to build and test against, along with various other options.
It will be triggered by a push or pull request and it will then: It will be triggered by a push or pull request and it will then:
@ -23,7 +23,7 @@ It will be triggered by a push or pull request and it will then:
- upload the addon file that it created along with a log of the test results - upload the addon file that it created along with a log of the test results
Create New Release Create New Release
================== ********************
``create_release.yaml`` allows you to specify the addon version that you want to create. ``create_release.yaml`` allows you to specify the addon version that you want to create.
The maintainer can decide whether the changes constitute a MAJOR, MINOR or PATCH release (e.g.: ``v1.5.12``): The maintainer can decide whether the changes constitute a MAJOR, MINOR or PATCH release (e.g.: ``v1.5.12``):
@ -33,7 +33,7 @@ The maintainer can decide whether the changes constitute a MAJOR, MINOR or PATCH
- PATCH - a typo, or bugfix - the ``.12`` in ``1.5.12`` - PATCH - a typo, or bugfix - the ``.12`` in ``1.5.12``
Docs Pages Docs Pages
========== ***********
``docs_pages.yml`` will build a complete documentation website based on the files in the ``docs`` folder. ``docs_pages.yml`` will build a complete documentation website based on the files in the ``docs`` folder.
Using the sphinx/Google docstring format allow this action to pull comments out of the code, and format them the same way as the Blender or Shapely docs. Using the sphinx/Google docstring format allow this action to pull comments out of the code, and format them the same way as the Blender or Shapely docs.