@lsbjordao/type-taxon-script 1.0.10 → 1.0.11
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.
- package/package.json +1 -1
- package/readme.md +22 -2
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lsbjordao/type-taxon-script",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.11",
|
|
4
4
|
"author": "Lucas Jordão <tucarj@gmail.com> & André Eppinghaus <andreeppinghaus@gmail.com> & Vicente Calfo <vicentecalfo@gmail.com>",
|
|
5
5
|
"license": "ISC",
|
|
6
6
|
"description": "TypeTaxonScript",
|
package/readme.md
CHANGED
|
@@ -6,7 +6,7 @@ Before you begin, ensure that Node.js is installed on your system. Node.js is es
|
|
|
6
6
|
|
|
7
7
|
## Install Git
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
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.
|
|
10
10
|
|
|
11
11
|
## Install Visual Studio Code
|
|
12
12
|
|
|
@@ -57,4 +57,24 @@ For comprehensive guidance on available commands and functionalities, access the
|
|
|
57
57
|
|
|
58
58
|
```bash
|
|
59
59
|
tts --help
|
|
60
|
-
```
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Initializing a TTS project
|
|
63
|
+
|
|
64
|
+
To initiate the use of a TTS project, execute the following command:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
tts init
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
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.
|
|
71
|
+
|
|
72
|
+
## Describing a new taxon
|
|
73
|
+
|
|
74
|
+
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:
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
tts new --genus Mimosa --species epithet
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
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.
|