Move and update documentation (#10)

Also remove yarn.lock to simplify getting started.
This commit is contained in:
Lars Karlitski 2017-10-18 16:47:48 +02:00 committed by Martin Pitt
parent 8ff4b33bb5
commit bd26aeda57
3 changed files with 20 additions and 2608 deletions

View file

@ -2,4 +2,23 @@
Scaffolding for a [Cockpit](http://www.cockpit-project.org) module.
See [docs/build-notes.md](docs/build-notes.md) for more information on how to build and install this package.
# Building
Run `npm install` to install dependencies and `make` to build the package. It
builds into the `dist` directory. Link or copy that to a location were
`cockpit-bridge` looks for packages.
`make install` compiles and installs the package in `/usr/share/cockpit/`. The
convenience targets `srpm` and `rpm` build the source and binary rpms,
respectively. Both of these make use of the `dist-gzip` target, which is used
to generate the distribution tarball. In `production` mode, source files are
automatically minified and compressed. Set `NODE_ENV=production` if you want to
duplicate this behavior.
# Vagrant
This directory contains a Vagrantfile that installs and starts cockpit on a
Fedora 26 cloud image. Run `vagrant up` to start it and `vagrant rsync` to
synchronize the `dist` directory to `/usr/local/share/cockit/starter-kit`. Use
`vagrant rsync-auto` to automatically sync when contents of the `dist`
directory change.