Techognito/starter-kit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: Drop '$' from verbatim commands

Browse source 
This make them easier to copy & paste.
This commit is contained in:
Martin Pitt 2024-07-09 13:43:13 +02:00 • committed by Martin Pitt
parent 9c61a574e7
commit 6cbc8ee65c
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -6,11 +6,11 @@ Scaffolding for a [Cockpit](https://cockpit-project.org/) module.
On Debian/Ubuntu: On Debian/Ubuntu:
$ sudo apt install gettext nodejs npm make sudo apt install gettext nodejs npm make
On Fedora: On Fedora:
$ sudo dnf install gettext nodejs npm make sudo dnf install gettext nodejs npm make
# Getting and building the source # Getting and building the source
@ -49,23 +49,23 @@ You can also use
[watch mode](https://esbuild.github.io/api/#watch) to [watch mode](https://esbuild.github.io/api/#watch) to
automatically update the bundle on every code change with automatically update the bundle on every code change with
$ ./build.js -w ./build.js -w
or or
$ make watch make watch
When developing against a virtual machine, watch mode can also automatically upload When developing against a virtual machine, watch mode can also automatically upload
the code changes by setting the `RSYNC` environment variable to the code changes by setting the `RSYNC` environment variable to
the remote hostname. the remote hostname.
$ RSYNC=c make watch RSYNC=c make watch
When developing against a remote host as a normal user, `RSYNC_DEVEL` can be When developing against a remote host as a normal user, `RSYNC_DEVEL` can be
set to upload code changes to `~/.local/share/cockpit/` instead of set to upload code changes to `~/.local/share/cockpit/` instead of
`/usr/local`. `/usr/local`.
$ RSYNC_DEVEL=example.com make watch RSYNC_DEVEL=example.com make watch
To "uninstall" the locally installed version, run `make devel-uninstall`, or To "uninstall" the locally installed version, run `make devel-uninstall`, or
remove manually the symlink: remove manually the symlink:
@ -81,11 +81,11 @@ eslint is executed as part of `test/static-code`, aka. `make codecheck`.
For developer convenience, the ESLint can be started explicitly by: For developer convenience, the ESLint can be started explicitly by:
$ npm run eslint npm run eslint
Violations of some rules can be fixed automatically by: Violations of some rules can be fixed automatically by:
$ npm run eslint:fix npm run eslint:fix
Rules configuration can be found in the `.eslintrc.json` file. Rules configuration can be found in the `.eslintrc.json` file.
@ -98,11 +98,11 @@ styleint is executed as part of `test/static-code`, aka. `make codecheck`.
For developer convenience, the Stylelint can be started explicitly by: For developer convenience, the Stylelint can be started explicitly by:
$ npm run stylelint npm run stylelint
Violations of some rules can be fixed automatically by: Violations of some rules can be fixed automatically by:
$ npm run stylelint:fix npm run stylelint:fix
Rules configuration can be found in the `.stylelintrc.json` file. Rules configuration can be found in the `.stylelintrc.json` file.