RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 07:57:46 +00:00
Code Issues Activity Actions

Documentation: Move all file format documentation into its own manpage

Browse source 
The documentation is largely unchanged except for adoption into the
standard manpage format.
This commit is contained in:
kleines Filmröllchen 2022-06-16 16:47:46 +02:00 • committed by Linus Groh
parent da25ac0d48
commit 9660f5d0e6
7 changed files with 125 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

22
Base/usr/share/man/man5/postcreate.md Normal file
View file

@ -0,0 +1,22 @@
## Name
postcreate - HackStudio postcreate scripts
## Synopsis
.postcreate shell scripts are executed by HackStudio after creating a new project.
## Description
It is possible to define project templates that set up HackStudio projects. These templates can contain custom setup logic in the form of a `*.postcreate` script in the template directory. The script name must match the template's (directory) name. Postcreate scripts are regular shell scripts. They are executed from an undeterminate directory with the following arguments:
- The path to the postcreate script
- The name of the new project
- The path of the new project, i.e. not the parent directory it was created in
- The project name in a form that is safe for C++ namespaces
The script may error out with a non-zero exit code, but the project is still created. The user is informed of the error.
## See Also
- `ProjectTemplate::create_project` in [`Userland/DevTools/HackStudio/ProjectTemplate.cpp`](../../../../../Userland/DevTools/HackStudio/ProjectTemplate.cpp).