TPN: Modify README.md of toponaming branch to help orientate testers (#7049)

Co-authored-by: luzpaz <[email protected]>  
Co-authored-by: Ajinkya Dahale <[email protected]>
This commit is contained in:
luzpaz
2022-07-01 03:42:44 +02:00
committed by Uwe
co-authored by luzpaz Ajinkya Dahale
parent 1021098106
commit 9d54041102
2 changed files with 50 additions and 2 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

+50 -2
View File
@@ -1,7 +1,53 @@
![Logo](https://www.freecadweb.org/images/logo.png)
<h6 align="center"><img src="FreeCAD-toponaming-logo.png"/></h6>
### Your own 3D parametric modeler
<h1 align="center">FreeCAD Topological Naming (toponaming) Branch</h1>
### About
This branch is dedicated to integrating code that improves the [topological naming problem](https://wiki.freecad.org/Topological_naming_problem) in FreeCAD. There have been several attempts to address it over the years within FreeCAD. In reality, toponaming is an issue that no modern CAD software is fully immune to. This is because the solutions are complex.
Thanks to an independent developer named Zheng Lei ('realthunder'), who has gone the farthest in the effort of fixing toponaming in FreeCAD, and has provided a proof of concept fix in his own branch named 'Link' branch.
* FreeCAD toponaming git repository: https://github.com/FreeCAD/FreeCAD/tree/development/toponaming
* FreeCAD main ('master') branch: https://github.com/FreeCAD/FreeCAD/
### Objective
Per the FreeCAD developer meetings that occurred during the pre-release of v0.20, 'toponaming' was identified as one of the main targets for merge in the v0.21/v1.0 release cycle.
### Main developers
* @realthunder
* @wwmayer
### Contributing
During this development cycle there will be nightly builds provided for testers to test and report results back to the developers.
<details>
<summary>Expand this section to learn about testing toponaming on different platforms/distros</summary>
#### Linux
##### Snap packages
A nightly Snap package of the 'toponaming' branch will be available to testers. Refer to the [Snap wiki page](https://wiki.freecad.org/Ubuntu_Snap#Notes)
#### Windows
TBD
#### macOS
TBD
#### FreeBSD
N/A
</details>
<!--
[Website](https://www.freecadweb.org) •
[Documentation](https://wiki.freecadweb.org) •
[Forum](https://forum.freecadweb.org/) •
@@ -126,3 +172,5 @@ learning to use FreeCAD.
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="91px">
</a> and <a href="https://www.kipro-pcb.com/">KiCad Services Corp.</a>
</p>
-->