spiegel-keyman/developer/docs/help/context/clone-github-project-parameters.md
Marc Durdin 46fc4d52cf feat(developer): add user interface for kmc copy to TIKE
Adds a new set of 'New Project' dialogs to allow authors to easily copy
keyboards from local filesystem, Keyman Cloud (including a keyboard
search web page, implemented in keymanapp/keyman.com#536), and
directly from a GitHub URL. Adds related documentation.

Fixes: #13073
Depends-on: keymanapp/keyman.com#536
2025-01-30 11:04:18 +07:00

34 lines
1.2 KiB
Markdown

---
title: Clone GitHub Project Parameters Dialog
---
![Clone GitHub Project Parameters dialog](../images/ui/frmCloneGitHubProjectParameters.png)
Allows you to clone a project from a GitHub repository, giving the project a
new id, and organizing project files following the
[file layout](/developer/keyboards/) used in the
[Keyman keyboards repository](https://github.com/keymanapp/keyboards).
Keyboard and lexical model projects can be cloned.
Projects can also be cloned from the command line with [`kmc copy`](kmc).
### Parameters
GitHub URL:
: The full URL to a source project .kpj file to copy, on github.com.
Destination path
: Specifies the base path where the project folder will be created.
The project folder name will be the keyboard ID. If the folder
already exists, then you will be prompted before Keyman Developer
overwrites files inside it.
New project ID
: The base filename of the keyboard/model, project and package. This must
conform to the Keyman keyboard or lexical model identifier rules.
Relocate external files into new project folder
: When selected, if the project references files that are not inside the same
folder as the .kpj file, move these files into an `external` subfolder