@drone1/alt 1.0.1 → 1.0.2
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/README.md +7 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -100,10 +100,12 @@ Sample output:
|
|
|
100
100
|
Note that output files can be lower-cased if you pass the ``--normalize-output-filenames`` option, so `fr-FR` translations would write to `fr-fr.json`
|
|
101
101
|
|
|
102
102
|
## Config file
|
|
103
|
-
[_optional_]
|
|
103
|
+
[_optional_] For convenience, a config file is supported. You can use a config file in conjunction with command-line arguments. Command-line arguments override config file values.
|
|
104
|
+
|
|
105
|
+
By default, ALT will search the output directory for `config.json`, but you can specify a path explicitly using
|
|
104
106
|
`--config-file`.
|
|
105
|
-
|
|
106
|
-
config:
|
|
107
|
+
|
|
108
|
+
Here's an example config:
|
|
107
109
|
|
|
108
110
|
```
|
|
109
111
|
{
|
|
@@ -123,12 +125,14 @@ Any of the above settings can be specified using command-line arguments (`--app-
|
|
|
123
125
|
|
|
124
126
|
## Adding context
|
|
125
127
|
Sometimes a string isn't enough to give context to the AI, and as a result, it may give an undesirable translation. ALT allows you to specify additional context for this reason.
|
|
128
|
+
|
|
126
129
|
### Application-level context
|
|
127
130
|
A global, application description can be specified `--app-context-message` (or `appContextMessage` in a [config](#config)).
|
|
128
131
|
For example, your config may include something like:
|
|
129
132
|
```json
|
|
130
133
|
"appContextMessage": "Voided is a MMORPG game based on outer space."
|
|
131
134
|
```
|
|
135
|
+
|
|
132
136
|
### String-specific context
|
|
133
137
|
Context can be added for any reference key/value pairs by passing `--look-for-context-data` (or setting `lookForContextData: true` in a [config](#config)).
|
|
134
138
|
|