kopia lustrzana https://github.com/vilemduha/blendercam
rst uses asterisk for list, not hyphen, doh
rodzic
c5b690561e
commit
0ffbfff803
|
@ -7,9 +7,9 @@ As a Blender extension, Fabex follows the guidelines laid out by the Blender Fou
|
|||
`Extension Guidelines <https://docs.blender.org/manual/en/latest/advanced/extensions/getting_started.html#how-to-create-extensions>`_
|
||||
|
||||
In short, Blender uses a modified version of the `pep8 <https://peps.python.org/pep-0008/>`_ standard, meaning:
|
||||
- Classes are `NamedLikeThis` - no spaces, all words capitalized
|
||||
- Functions, modules, variables, etc are `named_like_this` - spaces replaced with underscores, no capital letters
|
||||
- No `*` imports - e.g. `from module import *` should be rewritten to specify exactly what is being imported - `from module import Class, function, variable as other_name` etc.
|
||||
* Classes are `NamedLikeThis` - no spaces, all words capitalized
|
||||
* Functions, modules, variables, etc are `named_like_this` - spaces replaced with underscores, no capital letters
|
||||
* No `*` imports - e.g. `from module import *` should be rewritten to specify exactly what is being imported - `from module import Class, function, variable as other_name` etc.
|
||||
|
||||
Fabex extends the default line-length to 100 to allow some of the longer equations to remain on a single line.
|
||||
|
||||
|
@ -23,11 +23,11 @@ Project Structure
|
|||
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:
|
||||
- First, `utilities` are at the lowest level - they depend on external libraries (e.g.: `bpy`, `shapely`, `numpy` etc) and are used to power the other classes and functions
|
||||
- Second, are all the files in the main addon folder (e.g.: `cam_chunk`, `gcode_path`, `strategy`) and they use external libraries, as well as `utilities` to power Blender's functions
|
||||
- Third, `properties`, `operators` and `ui` are Blender classes that use `utilites` and the main files to integrate Fabex functions into Blender
|
||||
* First, `utilities` are at the lowest level - they depend on external libraries (e.g.: `bpy`, `shapely`, `numpy` etc) and are used to power the other classes and functions
|
||||
* Second, are all the files in the main addon folder (e.g.: `cam_chunk`, `gcode_path`, `strategy`) and they use external libraries, as well as `utilities` to power Blender's functions
|
||||
* Third, `properties`, `operators` and `ui` are Blender classes that use `utilites` and the main files to integrate Fabex functions into Blender
|
||||
|
||||
The rest of the files can be considered references:
|
||||
- `post_processors` and `presets` will be loaded based on user selections in Blender
|
||||
- `tests` contains automated testing functions related to Github Workflows (see the Testing page for more details)
|
||||
- `wheels` conatins the pre-built Python binaries that power the external dependencies `shapely` and `opencamlib` - they are loaded automatically by Blender
|
||||
* `post_processors` and `presets` will be loaded based on user selections in Blender
|
||||
* `tests` contains automated testing functions related to Github Workflows (see the Testing page for more details)
|
||||
* `wheels` conatins the pre-built Python binaries that power the external dependencies `shapely` and `opencamlib` - they are loaded automatically by Blender
|
|
@ -15,24 +15,19 @@ 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.
|
||||
|
||||
It will be triggered by a push or pull request and it will then:
|
||||
- checkout the repository and create the addon file
|
||||
- either download a new version of Blender, or restore the version downloaded from the previous workflow run
|
||||
- install the addon and run the Test Suite
|
||||
- upload the addon file that it created along with a log of the test results
|
||||
* checkout the repository and create the addon file
|
||||
* either download a new version of Blender, or restore the version downloaded from the previous workflow run
|
||||
* install the addon and run the Test Suite
|
||||
* upload the addon file that it created along with a log of the test results
|
||||
|
||||
Create New Release
|
||||
==================
|
||||
`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:
|
||||
- MAJOR - usually means many breaking changes
|
||||
- MINOR - a new feature, or changes that won't break compatibility with previous version
|
||||
- PATCH - a typo, or bugfix
|
||||
|
||||
With MAJOR, MINOR and PATCH corresponding with the version numbers 1.5.12:
|
||||
- MAJOR - 1
|
||||
- MINOR - .5
|
||||
- PATCH - .12
|
||||
The maintainer can decide whether the changes constitute a MAJOR, MINOR or PATCH release (e.g.: v1.5.12):
|
||||
* MAJOR - usually means many breaking changes - the 1 in v1.5.12
|
||||
* MINOR - a new feature, or changes that won't break compatibility with previous version - the .5 in 1.5.12
|
||||
* PATCH - a typo, or bugfix - the .12 in 1.5.12
|
||||
|
||||
Docs Pages
|
||||
==========
|
||||
|
|
Ładowanie…
Reference in New Issue