README : suppression d'espaces avant les :
This commit is contained in:
parent
ec30d78d3c
commit
e03ef4d0e7
1 changed files with 10 additions and 10 deletions
20
README.md
20
README.md
|
@ -7,19 +7,19 @@ machines and their disks associated.
|
||||||
|
|
||||||
## Why
|
## Why
|
||||||
|
|
||||||
`qemush` is **daemonless** : no bloaty long running process is needed for
|
`qemush` is **daemonless**: no bloaty long running process is needed for
|
||||||
`qemush` to work.
|
`qemush` to work.
|
||||||
|
|
||||||
`qemush` is **lightweight** : it only consists in a shell script to
|
`qemush` is **lightweight**: it only consists in a shell script to
|
||||||
automate repeated tasks and force good practices.
|
automate repeated tasks and force good practices.
|
||||||
|
|
||||||
`qemush` needs **few dependencies** : see section
|
`qemush` needs **few dependencies**: see section
|
||||||
[Dependencies](#dependencies) for details.
|
[Dependencies](#dependencies) for details.
|
||||||
|
|
||||||
`qemush` is **hackable** : you can [write your own launching
|
`qemush` is **hackable**: you can [write your own launching
|
||||||
scripts](#writing-a-launching-script) to make it work as intended.
|
scripts](#writing-a-launching-script) to make it work as intended.
|
||||||
|
|
||||||
`qemush` is **easy to setup** : you can make it work in a few steps, see
|
`qemush` is **easy to setup**: you can make it work in a few steps, see
|
||||||
section [Installation instructions](#installation-instructions).
|
section [Installation instructions](#installation-instructions).
|
||||||
|
|
||||||
## Good practices?
|
## Good practices?
|
||||||
|
@ -57,7 +57,7 @@ scripts
|
||||||
|
|
||||||
`qemush` acts as Unix user `qemu` to manage virtual machines. You need to
|
`qemush` acts as Unix user `qemu` to manage virtual machines. You need to
|
||||||
create a system user `qemu` that cannot login, with any home directory,
|
create a system user `qemu` that cannot login, with any home directory,
|
||||||
in an Unix group of the same name. Example :
|
in an Unix group of the same name. Example:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Example if the qemu user doesn't exist
|
# Example if the qemu user doesn't exist
|
||||||
|
@ -72,7 +72,7 @@ For ease of use, you need to grant every user in the `qemu` group via
|
||||||
### Add `qemush` in the `PATH`
|
### Add `qemush` in the `PATH`
|
||||||
|
|
||||||
Use your preferred way to add the `qemush` script to a folder of `PATH`.
|
Use your preferred way to add the `qemush` script to a folder of `PATH`.
|
||||||
Recommended : copy the script in `/usr/local/bin` to make it effortlessly
|
Recommended: copy the script in `/usr/local/bin` to make it effortlessly
|
||||||
system wide.
|
system wide.
|
||||||
|
|
||||||
### Extra: add `first-free-port` in `PATH`
|
### Extra: add `first-free-port` in `PATH`
|
||||||
|
@ -92,7 +92,7 @@ The default text editor used by `qemush` is `nvim`, but it can be
|
||||||
overriden by the `EDITOR` environment variable.
|
overriden by the `EDITOR` environment variable.
|
||||||
|
|
||||||
Run the following command to start editing a launching script by the name
|
Run the following command to start editing a launching script by the name
|
||||||
of your choice :
|
of your choice:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
qemush edit "$name"
|
qemush edit "$name"
|
||||||
|
@ -103,13 +103,13 @@ Example scripts are available in this repo's `qemu/bin` folder.
|
||||||
### Launching a virtual machine
|
### Launching a virtual machine
|
||||||
|
|
||||||
Virtual machines are identified by the name of their launching scripts.
|
Virtual machines are identified by the name of their launching scripts.
|
||||||
You can launch any machine with the following command :
|
You can launch any machine with the following command:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
qemush start "$name"
|
qemush start "$name"
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also list all available virtual machines by running this command :
|
You can also list all available virtual machines by running this command:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
qemush ls
|
qemush ls
|
||||||
|
|
Loading…
Reference in a new issue