252e2c3b3e
docs: update architecture docs for addon-first model ( #255 )
...
Build and Test / build (pull_request) Failing after 2m1s
ARCHITECTURE.md:
- Replace exec()-based bootstrap flow with manifest-driven loader diagram
- Add addon lifecycle section (scan → parse → validate → resolve → load → register)
- Add SDK and C++ scaffold to source layout
- Document load order: sdk (0) → ztools (50) → silo (60)
INTEGRATION_PLAN.md:
- Add Layer 4 (Addon SDK) between bootstrap and addons (now 5 layers)
- Update Layer 3: now hosts both Python loader AND C++ scaffold
- Add Phase 1.5 (SDK) and Phase 1.75 (C++ scaffold) as DONE
- Update Phase 4 (theme): colors centralized in SDK YAML palette
- Update Phase 6 (build): now DONE with CMake install rules for all addons
- Add design decisions #7 (SDK as adaptation layer) and #8 (manifest-driven loading)
README.md:
- Update addon integration section: manifest-driven loading, SDK wrappers
- Add mods/sdk/ to project structure tree
- Update Create module description to mention C++ scaffold
Closes #255 .
2026-02-17 12:38:18 -06:00
a8df078eb3
docs: extend README with architecture, platform support, and usage detail
...
Build and Test / build (pull_request) Successful in 35m8s
Add editing context system description, built-in context table, and
Python API reference. Add architecture section covering addon
integration and unified origin system. Expand ztools and Silo usage
sections with command breakdowns. Add platform support table. Expand
project structure tree with Kindred-specific files.
2026-02-16 11:02:11 -06:00
forbes
831ad1376a
fix: resolve PR conflicts with origin/main
...
Build and Test / build (pull_request) Failing after 4m45s
- Remove .github/FUNDING.yml (upstream FreeCAD only, not Kindred)
- Sync .gitignore, .pre-commit-config.yaml, .pylintrc from origin/main
- Sync README.md, cMake/FindNETGEN.cmake from origin/main
- Sync pixi.lock, pixi.toml from origin/main
- Reset mods/ztools submodule pointer to match origin/main
2026-02-14 10:23:44 -06:00
forbes
630b08ea23
cherry-pick #3 : dock task panel right, remove non-Kindred themes ( bb3f3ac6d6)
2026-02-13 14:06:01 -06:00
JIJINBEI
379179ce2b
README: Update compiling section to recommend pixi ( #27501 )
2026-02-11 21:36:18 +00:00
Chris Hennes
4daf8d3b38
Remove Liberapay badge from README
2025-10-25 14:37:36 -05:00
Max Wilfinger
6d078d3836
Change links to weekly releases
2025-08-12 11:39:42 -05:00
Sunless
93d90ef96e
Improve wording and grammar in README introduction
...
Reworded the sentence about sketching geometry-constrained 2D shapes to improve clarity and grammar. This change makes the introduction easier to read and more precise for new users.
2025-08-09 08:53:12 -05:00
Lukas Neubert
928556c5e5
readme: fix discord invite
2025-02-21 08:06:16 +01:00
Kris
fcf0b75c39
Update wording in README ( #15766 )
...
* Update moto in README
* Updated Installation section on README
* Update compiling section in README
* Removed link to page
* Updated Contributing section of README
* Added section divider for sponsors in README
* Moved underlying technology into collapsible box
* Updated Overview section of README
* Updated help section in README
* Switch note on README
* Update header in README
* Revert "Update moto in README"
This reverts commit a7ba483a1aa7e410bde01dd42bf5ef0c7d3d8ca8.
* Revert "Updated Contributing section of README"
This reverts commit 2b4a1fdb9f2cf838039c30c755179f1c1b2b0bec.
* Updated overview section description
* Fixed wording in overview
* Restored section header line
* Revert "Updated Overview section of README"
This reverts commit accff3fdb9cefde9b691fa654512903877140cab.
* Partial revert of 52d9c8a
* Revert "Moved underlying technology into collapsible box"
This reverts commit d1cc1ae87b8eee5702611ecb50c0067c50ae05c6.
* Added newlines to compiling section
2024-11-04 17:53:05 +01:00
Max Wilfinger
2d57e9f2af
Add safe mode description to issue template and guide in readme
2024-10-23 16:16:13 -05:00
Wiktor Perskawiec
b935c6a740
README: fix typos
2024-10-23 08:22:50 -05:00
Max Wilfinger
8b8f591a8a
Update images on XDGData and README
2024-10-07 14:54:41 +02:00
Max Wilfinger
3d8cc4a465
GitHub: Add text to readme and the issue template to record macros for bugs ( #15761 )
...
* Add text to readme and the issue template that the user should record a macro when recreating the issue and sharing this macro in the issue.
Updated old links from master branch to main.
2024-08-04 15:15:58 -05:00
obelisk79
3eb45b045c
[UI] Logo Update ( #14284 )
...
* Updating instances of FreeCAD's old logo to reflect the new Logo
* updating additional instances of the Logo
* updating additional instances of the Logo
* Update logo for windows installer
* Update logo reference to /src/Gui/Icons/freecad.svg
2024-05-27 15:33:55 -04:00
Chris Hennes
a8ea4e5b08
Update the README
2023-08-02 03:34:40 +00:00
Yorik van Havre
1f5c6c2d94
README: Added funding info + small format fixes
2023-05-08 11:28:34 +02:00
luzpaz
129d5882a7
Migrate domain name from freecadweb to freecad ( #9352 )
...
* Migrate domain name from freecadweb to freecad
* Migrate src/Mod/Material files
* Migrate Stylesheet related files
* Migrate *.svg files
* Migrate miscellaneous files
* Migrate some build files
* Migrate recently added TD AR_IRAM template files
Closes #6415
2023-04-24 15:19:20 -05:00
luzpaz
324dcc758e
README: fix bugtracker link
2023-01-24 15:01:21 +01:00
luzpaz
d765405bce
README: remove lgtm badges
...
lgtm was sunset in Dec 2022. https://github.blog/2022-08-15-the-next-step-for-lgtm-com-github-code-scanning/
2023-01-20 23:24:07 -06:00
luzpaz
2d6a768a6b
README: update bugtracker related links and info
...
Link to github instead of mantis.
Update links on how to submit bugs + feature requests
Add link to CONTRIBUTING.md
2023-01-10 13:08:54 +01:00
luz paz
b3ffcf72a7
[skip ci] README: fix broken link to FC logo
...
Closes #7595
Migrated from markdown link to HTML. Added a hyperlink to homepage as well.
2022-10-12 09:18:35 -04:00
Uwe
453abff2fe
update screenshot in Readme
...
update screenshot to FC 0.20
2022-06-16 14:19:45 +02:00
Uwe
a1a4b89ba8
Update Readme to FreeCAD 0.20
2022-06-16 13:05:53 +02:00
TotalCaesar659
d8ca3093d0
Update URL to HTTPS
2022-06-14 14:13:44 +02:00
Ajinkya Dahale
650210e2db
[Readme] Update build status badges
...
The old Travis-CI badges are about a year old. These changes replace the links with those for Gitlab-CI.
Adapted from instructions at https://docs.gitlab.com/ee/user/project/badges.html#use-custom-badge-images .
2022-05-20 04:03:22 +02:00
adrianinsaval
638fd41db7
Update README.md installation info
...
requested in forum: https://forum.freecadweb.org/viewtopic.php?p=570177#p570177
2022-02-10 17:19:49 +01:00
Yorik van Havre
a6450a9584
Readme: Added LGTM C++ badge
2021-05-12 16:47:42 +02:00
Yorik van Havre
f0564b0f4b
Readme: Changed stable build badge version from 0.18 to 0.19 + added kicad sponsor
2021-05-12 16:42:09 +02:00
Ryan White
91a2b0495f
Update README.md
...
Updated per comments on first PR
2020-12-10 00:52:46 -08:00
Ryan White
eb4e641e7f
Update README.md
...
Added details on reporting issues to the README.md file
2020-12-07 11:38:23 -08:00
luz paz
a5adc3eb8b
README: minor nitpick [skip ci]
...
This commit didn't make it in to f33ca46076
2020-11-05 15:21:42 +01:00
luz paz
19a5190243
Swap comma for period
2020-11-03 15:18:34 +01:00
Allan Nordhøy
70f4e523c2
Line 38 removed.
2020-11-03 15:18:34 +01:00
Allan Nordhøy
94ca8ac9af
Requested suggestions added
2020-11-03 15:18:34 +01:00
Allan Nordhøy
f33ca46076
Typos and language in README
2020-11-03 15:18:34 +01:00
marioalexis
6d819854c6
README.md: Fix links to wiki
2020-10-06 12:35:48 +02:00
marioalexis
3f89175c36
README.md: Fix link to FAQ
2020-10-06 12:35:48 +02:00
Yorik van Havre
376299d55e
Added liberapay badge to readme
2020-09-21 15:03:02 +02:00
sgrogan
2b3b61827a
Update digital ocean citation
2020-06-03 14:44:44 +02:00
sgrogan
a0692b14cc
[DON'T MERGE]read.me digitalocean
...
todo better 'This project receives support from:'
2020-06-03 14:44:44 +02:00
Kurt Kremitzki
8deed98ace
Add DigitalOcean support notice
2020-02-10 11:20:21 +01:00
Yorik van Havre
c77937e6c5
Added LGTM quality badge
2019-10-21 15:51:57 -03:00
Yorik van Havre
fa8c7fd48e
More fine-tuning in README
2019-04-30 10:13:03 -03:00
Yorik van Havre
5bf83c52d1
Minor fixes to README
2019-04-30 10:11:02 -03:00
Markus Reitboeck
70965a32b9
Readme: remove html content
...
as requested in pull request:
https://github.com/FreeCAD/FreeCAD/pull/2107
Unfortunately in plain Markdown it is not possible to align
content
2019-04-30 10:09:07 -03:00
Markus Reitboeck
6afe45eac9
Readme: improve overview section with contents from website
2019-04-30 10:09:07 -03:00
Markus Reitboeck
b0ad64e81a
Readme: make logo a little bit smaller
2019-04-30 10:09:07 -03:00
Markus Reitboeck
bec97f0aec
Readme: align screenshot horizontally in center
2019-04-30 10:09:07 -03:00
Markus Reitboeck
ea3e325339
Readme: add gitter, build and translation badges on top
2019-04-30 10:09:07 -03:00