scaffolder
- Python 100%
|
zoomlogo
4991c0bc22
add version flag and fix a bug
i forgot to do variable substitution in the new field |
||
|---|---|---|
| mkproj | add version flag and fix a bug | |
| .gitignore | .gitignore update | |
| COPYING | init | |
| pyproject.toml | add version flag and fix a bug | |
| README.txt | add version flag and fix a bug | |
| TEMPLATE_FORMAT.txt | add "finally" field | |
mkproj ====== A simple TUI for making new projects quickly. Installation ------------ Requires either uv or pipx. First clone the repository using git. Then run: uv tool install . or pipx install . Usage ----- When the program is called, it looks for template files in ~/.config/mkproj directory. The templates are defined using JSON. To understand how these files are structured, read ./TEMPLATE_FORMAT.txt. After defining all of your templates, running mkproj (in say ~/projects) will prompt you to give it the project name, description and the author name. After that, mkproj loads all language files and prompts you to select one of them. Then mkproj loads all template definitions from the selected language file. After this, mkproj prompts you to select a template and then select any remaining options (unselected by the template) such as documentation and license. Finally it runs "git init". In short, running the program is as easy as running: mkproj Flags ~~~~~ To add licenses or documentation to any existing project, you can run the following commands respectively: mkproj -L/--license-only mkproj -D/--documentation-only in the directory of the project. COPYING ======= This project is licensed under the MIT License. Read COPYING for more information. CHANGELOG ========= v0.1.4 fix substitution bug and add -v flag. v0.1.3 add "finally" field to template format. v0.1.2 add -L and -D options. v0.1.1 change filenames for documentation engine and license. v0.1.0 mkproj released.