{"id":17113043,"url":"https://github.com/emmt/yplugin","last_synced_at":"2025-03-23T22:28:07.860Z","repository":{"id":32542301,"uuid":"36124330","full_name":"emmt/YPlugin","owner":"emmt","description":"Script to help creating a Git repository for a Yorick plug-in","archived":false,"fork":false,"pushed_at":"2022-03-16T10:40:47.000Z","size":88,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-29T05:41:23.632Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emmt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-23T13:26:07.000Z","updated_at":"2022-03-16T10:40:51.000Z","dependencies_parsed_at":"2022-09-15T05:23:24.952Z","dependency_job_id":null,"html_url":"https://github.com/emmt/YPlugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emmt%2FYPlugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emmt%2FYPlugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emmt%2FYPlugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emmt%2FYPlugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emmt","download_url":"https://codeload.github.com/emmt/YPlugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245177266,"owners_count":20573072,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T17:02:32.040Z","updated_at":"2025-03-23T22:28:07.831Z","avatar_url":"https://github.com/emmt.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YPlugin\n\nThis is a simple script to help you creating a Git repository for a\n[Yorick](http://github.com/LLNL/yorick/) plug-in.\n\nCompared to the standard:\n\n```sh\nyorick -batch make.i\n```\n\nthis script populates a directory with initial files (`Makefile`,\n`LICENSE.md`, `README.md`, `AUTHORS`, *etc.*), initializes this directory as\na Git repository (with suitable `.gitignore` and `.gitattributes` files)\nand provides you with a `configure` script such that configuration, build\nand installation are easier for a user (for instance, the plug-in can be\nbuilt in a different directory leaving the source tree unchanged).\n\n\n## Usage\n\nYou simply execute the [`create`](./create) script with a few parameters:\n\n```sh\n./create [-h|--help] [OPTIONS] [--] NAME [DESTDIR]\n```\n\nto create an initial Git repository for Yorick plugin `NAME` in directory\n`DESTDIR` which must not already exists.  If `DESTDIR` is not given, it is\ntaken to be the argument `NAME` (with `/` replaced by `-`).  Note that the\nscrip may be executed from anywhere.\n\nPossible options are:\n* `--author=AUTHOR`      Author(s) of the plug-in.\n* `--email=EMAIL`        Email address to join the author(s).\n* `--descr=DESCR`        Short description of the plug-in.\n* `--license=mit|gpl|lgpl|cecill|cecill-b|cecill-c|none`\n                         Type of license.\n* `--cflags=CFLAGS`      Default compiler flags.\n* `--deplibs=DEPLIBS`    Default flags for dependencies.\n* `--ldflags=LDFLAGS`    Default linker flags.\n* `--pkg_i=PKG_I`        Name of Yorick file with plug-in code.\n* `--pkg_c=PKG_C`        Name of C file with C code.\n* `--debug`              Debug mode.\n* `-h`, `--help`         Print help and exit.\n\nThe default license is `MIT`, you can specify `none` to not choose an\ninitial license.  Letter case is not significant for the license.  The\nvalues of `--cflags`, `--deplibs` and `--ldflags` are used to set default\nvalues in the `configure` script of the plug-in.  If unspecified, the\nauthor name and email are guessed from the global Git configuration\nparameters or from the informations available in `/etc/passwd`.  If not yet\ndone, you may set these with:\n\n```sh\ngit config --global user.name \"FULL NAME\"\ngit config --global user.email \"EMAIL\"\n```\n\nIf you accept the settings, the `create` script makes the `DESTDIR` and\npopulates it with some initial files.  Instructions in the `README.md` file\nexplain how to use the `configure` script to build the plug-in.\n\n\n## Macros and file names\n\n* `PKG_NAME` is used as the base name for the package dynamically loaded\n  library (DLL) and, prefixed by `yk_`, as the name of the function in the\n  DLL to call to initialize the plug-in.  Thus letters, digits and\n  underscores are the only allowed characters for `PKG_NAME`.  The value of\n  this macro is built from the plug-in name converted to lowercase and\n  with all sequences of forbidden characters replaced by a single\n  underscore.\n\n* Option `--pkg_i=PKG_I` can be used to specify the name of the Yorick\n  source file which has to be `#include`d to load the plug-in.  It\n  corresponds to macro `PKG_I` in `Makefile`.  The default value is\n  `$PKG_NAME.i`.\n\n* Option `--pkg_c=PKG_C` can be used to specify the name of the main\n  C file which has to be compiled to make the plug-in.  Its default value\n  is `$PKG_NAME.c`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femmt%2Fyplugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femmt%2Fyplugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femmt%2Fyplugin/lists"}