Update README.md

This commit is contained in:
Nathan 2023-03-07 11:44:20 -06:00 committed by GitHub
parent f2adb9dab5
commit 31edff2f83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,2 +1,39 @@
# JSRepl.desktop
A .desktop file that launches a quick JavaScript REPL in Kate and Konsole
*A .desktop file that launches a quick JavaScript REPL in KWrite and Konsole*
If you're anything like me:
* You're an avid KDE user
* You've been using tools like [RunJS](https://github.com/lukehaas/RunJS) to try things out, fix bugs, format text, et cetera, but...
* you think [Electron](https://github.com/electron/electron) should die in a fire,
* you want to use FLOSS tools where at all possible,
* ...and you don't really need all sorts of fancy features anyway.
Well, here you go, friend. This quick and dirty .desktop file creates `repl.js` in the liminal space that is your `/tmp/` directory, opens it in KWrite, and opens up a Konsole window that watches `/tmp/repl.js` for changes and runs them in node using nodemon (IE, gives you a barebones JavaScript REPL).
## Screenshot:
![image](https://user-images.githubusercontent.com/8893713/223494042-20b4915b-382e-43b2-8d4b-16dbc265be56.png)
## Requirements:
* A GNU/Linux distro with KWrite, Konsole, and Node installed
## Setup:
1. Install nodemon
```bash
npm i -g nodemon
```
2. Drop JSRepl.js wherever it needs to live on your system
```bash
cd /my/applications/dir && wget https://raw.githubusercontent.com/N-Upchurch/JSRepl.desktop/main/JSRepl.desktop
```
## Use:
* Open your application launcher and click on JSRepl to launch
* Write code
* Save to run your code (or if you're really fancy, and brave, turn on autosave in KWrite)
## FAQs:
* Does it work with TypeScript?
* My guy, if I wanted *types* I'd learn a *real* programming language.
* Does it have X feature?
* Probably not; it's just a .desktop file. Feel free to submit a PR if you have ideas.
* Do I have to use KWrite and Konsole?
* Not if you change the program names in JSRepl.desktop, but you're on your own from there.