@lsbjordao/type-taxon-script 1.0.10 → 1.0.12

package/dist/exportSources.js

@@ -11,7 +11,7 @@ function ttsExportSources(genus) {
         return;
     }
     if (!fs_1.default.existsSync('./input') && !fs_1.default.existsSync('./output')) {
-        console.error("\x1b[31m✖ The ./input and ./output directories are not present within the project.\x1b[0m\n\x1b[33mℹ️ Please run `tts init` before attempting to export a database.\x1b[0m");
+        console.error("\x1b[31m✖ The ./input and ./output directories are not present within the project.\x1b[0m\n\x1b[36mℹ️ Please run \x1b[33m`tts init`\x1b[36m before attempting to export a database.\x1b[0m");
         return;
     }
     const filePath = `./output/${genus}DB.json`;

package/dist/exportToCsv.js

@@ -41,7 +41,7 @@ function ttsExportToCsv(genus, load) {
             return;
         }
         if (!fs_1.default.existsSync('./input') && !fs_1.default.existsSync('./output')) {
-            console.error("\x1b[31m✖ The ./input and ./output directories are not present within the project.\x1b[0m\n\x1b[33mℹ️ Please run `tts init` before attempting to export a database.\x1b[0m");
+            console.error("\x1b[31m✖ The ./input and ./output directories are not present within the project.\x1b[0m\n\x1b[36mℹ️ Please run \x1b[33m`tts init`\x1b[36m before attempting to export a database.\x1b[0m");
             return;
         }
         const spinner = new cli_spinner_1.Spinner('\x1b[36mProcessing... %s\x1b[0m');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lsbjordao/type-taxon-script",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "author": "Lucas Jordão <tucarj@gmail.com> & André Eppinghaus <andreeppinghaus@gmail.com> & Vicente Calfo <vicentecalfo@gmail.com>",
   "license": "ISC",
   "description": "TypeTaxonScript",

package/readme.md

@@ -6,7 +6,7 @@ Before you begin, ensure that Node.js is installed on your system. Node.js is es
 
 ## Install Git
 
-Ensure that Git (https://git-scm.com/) is installed on your system.
+Make sure you have Git installed or visit its official website at https://git-scm.com/ and install Git for your system. Git facilitates efficient version control for your projects, enabling seamless change tracking, collaboration, and codebase management.
 
 ## Install Visual Studio Code
 
@@ -57,4 +57,24 @@ For comprehensive guidance on available commands and functionalities, access the
 
 ```bash
 tts --help
-```
+```
+
+## Initializing a TTS project
+
+To initiate the use of a TTS project, execute the following command:
+
+```bash
+tts init
+```
+
+This command will verify the presence of an existing TTS project within the directory. Additionally, it will generate two mandatory directories, `./input` and `./output`, but only if the `characters` and `taxon` directories already exist. These newly created directories are essential for the project functioning.
+
+## Describing a new taxon
+
+To generate a new `.ts` file containing a comprehensive script outlining the entire hierarchy of characters, serving as the foundational template to initiate the description of a species from scratch, utilize the command `tts` followed by the `-new` argument, specifying the genus name and the specific epithet as shown below:
+
+```bash
+tts new --genus Mimosa --species epithet
+```
+
+After the process, a new file named `Mimosa_epithet.ts` will be created in the `./output` directory. To access this script file, simply hold down the `Ctrl` key and click on the file path displayed in the console. However, before you begin editing the script, it is important to relocate this file to the `./taxon` directory, as the script specifically functions within that directory. Outside this directory, the script will not works properly. Opening the script outside of this directory will trigger multiple dependency errors.