isaacscript 3.18.3 → 3.18.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -123,7 +123,10 @@ function copyDynamicFiles(projectName, authorName, projectPath, packageManager,
123
123
  const template = readFile(templatePath);
124
124
  // "PROJECT-NAME" must be hyphenated, as using an underscore will break Prettier for some
125
125
  // reason.
126
- const readmeMD = template.replaceAll("PROJECT-NAME", projectName);
126
+ const command = getPackageManagerInstallCICommand(packageManager);
127
+ const readmeMD = template
128
+ .replaceAll("PROJECT-NAME", projectName)
129
+ .replaceAll("PACKAGE-MANAGER-INSTALL-COMMAND", command);
127
130
  const destinationPath = path.join(projectPath, README_MD);
128
131
  writeFile(destinationPath, readmeMD);
129
132
  }
@@ -18,6 +18,7 @@ If you are a developer, or if the mod is not yet uploaded to the Steam Workshop,
18
18
  - Unzip the zip file to a new directory.
19
19
  - Open the command prompt (or another shell of your choice).
20
20
  - Use the `cd` command to navigate to the place where you unzipped the repository.
21
- - Use the `npm run start` command to start the IsaacScript watcher.
21
+ - Use the `PACKAGE-MANAGER-INSTALL-COMMAND` command to install the project dependencies.
22
+ - Use the `npx isaacscript` command to start the IsaacScript watcher.
22
23
  - If IsaacScript is successful, you will see "Compilation successful." (You can continue to leave the terminal window open; it will monitor for changes in your project, and recompile if necessary.)
23
24
  - Completely close Isaac if it is already open, and then open the game again, and the mod should be in the list of mods. You can now play or test the mod.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "isaacscript",
3
- "version": "3.18.3",
3
+ "version": "3.18.4",
4
4
  "description": "A command line tool for managing Isaac mods written in TypeScript.",
5
5
  "keywords": [
6
6
  "isaac",