Skip to content

Commit

Permalink
fix docs, fold something
Browse files Browse the repository at this point in the history
  • Loading branch information
NaitLee committed Jun 14, 2022
1 parent 9007453 commit 1492e90
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,11 @@ But currently *none* of existing templates will work perfectly.

## FaQ

**Why "Trait-TPL"?**
<details>

<summary>Expand FaQ</summary>

**Why "Tradit-TPL"?**
I casually took it from word "traditional". But that word is not the case -- we have new way.
And pronounce that "tra" as in "trap".

Expand All @@ -38,16 +42,24 @@ Since it's non-production, it yet can't be determined.
But it's certainly true that so-called "injection" **won't** work!
*Leave away from those tech imps.* Test your case with good tools like [OWASP ZAP](https://www.zaproxy.org/), *not a mouth*.

</details>

## Dev

- Prepare: `cd` to repo, `npm install`
- Transpile: `npx tsc`

<details>

<summary>Tips for Linux/*nix</summary>

Symlinking `dist` to plugin folder as `Tradit-TPL` helps.

Under X11 (yes, neither Windows/Wine nor Wayland), HFS can't reload correctly with `npx tsc --watch`, after 2 times.
Assign a keybinding to your DE (like KDE Plasma) to run `touch /<DEV_PATH_HERE>/Tradit-TPL/dist/plugin.js`. My choice is `Ctrl+Alt+Shift+S`.

</details>

Far more things are going to be changed, and many macros are not implemented yet.

Don't pay too much attention as for now...
Expand Down
2 changes: 1 addition & 1 deletion tradit-handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export class Handler {
API.setConfig(CFG_KEY_PATH, path);
return; // let subscriber work
} else {
API.log('Please select a template in plugin configuration');
API.log('Please manually select a template in plugin configuration');
return;
}
}
Expand Down

0 comments on commit 1492e90

Please sign in to comment.