Skip to content

Commit

Permalink
docs: update readme and template
Browse files Browse the repository at this point in the history
  • Loading branch information
bc-m committed Mar 12, 2024
1 parent 8055f9d commit cc17a87
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,24 @@ The extracted content is organized into directories based on the context of the
├── custom_functions
│ └── [FileMaker database name]
│ └── [CF name] - ID [CF ID].txt
├── custom_menu_sets
│ └── [FileMaker database name]
│ └── [Set name] - ID [Set ID].txt
├── custom_menus
│ └── [FileMaker database name]
│ └── [Menu name] - ID [Menu ID].txt
├── extended_privileges
│ └── [FileMaker database name]
│ └── [Privileges name] - ID [Privileges ID].txt
├── external_data_sources
│ └── [FileMaker database name].xml
├── layouts
│ └── [FileMaker database name]
│ └── [Directory name] - ID [Directory ID]
│ └── [Layout name] - ID [Layout ID].xml
├── privilege_sets
│ └── [FileMaker database name]
│ └── [Set name] - ID [Set ID].txt
├── relationships
│ └── [FileMaker database name]
│ └── [Left Table name] - [Right Table name] - ID [Relationship ID].xml
Expand All @@ -61,7 +73,7 @@ The extracted content is organized into directories based on the context of the
└── [Value list name] - ID [Value list ID].xml
```

For multi-file solutions it can be helpful to create a separate Git repository for each of these directories (`custom_functions`, `external_data_sources`, `layouts`, `scripts`, `scripts_sanitized`, `tables`, `themes`, `value_lists`) to manage version control and collaboration effectively.
For multi-file solutions it can be helpful to create a separate Git repository for each of these directories (`custom_functions`, `layouts`, `scripts`, `tables` and so on) to manage version control and collaboration effectively.

## Why this structure?

Expand Down Expand Up @@ -114,9 +126,9 @@ Contributions are welcome! Feel free to open issues or pull requests on the [Git
- [x] ScriptCatalog
- [x] ThemeCatalog
- [x] LayoutCatalog
- [ ] PrivilegeSetsCatalog
- [ ] ExtendedPrivilegesCatalog
- [x] PrivilegeSetsCatalog
- [x] ExtendedPrivilegesCatalog
- [ ] AccountsCatalog
- [x] StepsForScripts
- [ ] CustomMenuCatalog
- [ ] CustomMenuSetCatalog
- [x] CustomMenuCatalog
- [x] CustomMenuSetCatalog
4 changes: 4 additions & 0 deletions template/init_repos.bash
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@

folders=(
"custom_functions"
"custom_menu_sets"
"custom_menus"
"extended_privileges"
"external_data_sources"
"layouts"
"privileges_sets"
"relationships"
"scripts"
"scripts_sanitized"
Expand Down
4 changes: 4 additions & 0 deletions template/run.bash
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,12 @@ set +e
# Define an array of folders
folders=(
"custom_functions"
"custom_menu_sets"
"custom_menus"
"extended_privileges"
"external_data_sources"
"layouts"
"privileges_sets"
"relationships"
"scripts"
"scripts_sanitized"
Expand Down

0 comments on commit cc17a87

Please sign in to comment.