Skip to content

Commit

Permalink
README: Various updates
Browse files Browse the repository at this point in the history
- Add a summary what this does.
- Drop the `$` from the verbatim commands to make them easier to copy &
  paste.
- `fedora-38` image is no more. Change the example to `fedora-rawhide`,
  which is persistent.
  • Loading branch information
martinpitt committed Jul 9, 2024
1 parent 748eafd commit 249f71e
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# Cockpit Files

This is the [Cockpit](https://cockpit-project.org/) user interface for managing
files.


# Development dependencies

On Debian/Ubuntu:

$ sudo apt install gettext nodejs npm make
sudo apt install gettext nodejs npm make

On Fedora:

$ sudo dnf install gettext nodejs npm make
sudo dnf install gettext nodejs npm make


# Getting and building the source
Expand Down Expand Up @@ -47,23 +51,23 @@ You can also use
[watch mode](https://esbuild.github.io/api/#watch) to
automatically update the bundle on every code change with

$ npm run watch
npm run watch

or

$ make watch
make watch

When developing against a virtual machine, watch mode can also automatically upload
the code changes by setting the `RSYNC` environment variable to
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
set to upload code changes to `~/.local/share/cockpit/` instead of
`/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
remove manually the symlink:
Expand All @@ -79,11 +83,11 @@ eslint is executed as part of `test/static-code`, aka. `make codecheck`.

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:

$ npm run eslint:fix
npm run eslint:fix

Rules configuration can be found in the `.eslintrc.json` file.

Expand All @@ -96,11 +100,11 @@ styleint is executed as part of `test/static-code`, aka. `make codecheck`.

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:

$ npm run stylelint:fix
npm run stylelint:fix

Rules configuration can be found in the `.stylelintrc.json` file.

Expand All @@ -126,4 +130,4 @@ It is possible to setup the test environment without running the tests:

You can also run the test against a different Cockpit image, for example:

TEST_OS=fedora-38 make check
TEST_OS=fedora-rawhide make check

0 comments on commit 249f71e

Please sign in to comment.