From cfefe02a8670c3c22ab3ffea95f79c3eda83609c Mon Sep 17 00:00:00 2001 From: Samuel Aubertin Date: Wed, 20 Sep 2023 08:59:21 +0200 Subject: [PATCH] more readme --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d65d776..0bb23af 100644 --- a/README.md +++ b/README.md @@ -5,24 +5,31 @@ Sk4nZ OpenBSD Packer **skz-opack** enables simple execution of [OpenBSD](https://www.openbsd.org) virtual machines from a Linux host or Google Cloud Compute, leveraging Packer and Vagrant, from a Makefile target named `opack`. -## Installation Instructions +## Instructions To get started with **skz-opack**, follow these steps: 1. Clone the repository using the following command: ```sh - git clone https://www.sk4.nz/skz-opack.git + git clone https://git.sk4.nz/sk4nz/skz-opack.git ``` 2. Ensure you have the following dependencies installed: - - GNU Make + - [GNU Make](https://www.gnu.org/software/make/) - [libvirt](https://libvirt.org/) - [Vagrant](https://www.vagrantup.com/) - [Vagrant-Libvirt module](https://github.com/vagrant-libvirt/vagrant-libvirt) 3. Use the project by including `path/to/skz-opack/src/opack.mk` and invoking the `opack` target in your Makefile to create and manage OpenBSD virtual machines with Packer and Vagrant. +## Architecture + + + ## Available make targets -Available make target are `opack`, `clean` and `cleancache`. +Available make target are: +- `opack` +- `clean` +- `cleancache` ## Examples ### Quick example @@ -36,7 +43,7 @@ include path/to/src/opack.mk # mandatory After invokation with `make opack`, it will download, install, and run the latest OpenBSD release in a local VM. Once executed, the VM is running and it is possible to log into it using the `vagrant ssh` command. -Then, `make clean` will remove the VM, but not the vagrant image. When reinvoking `make opack`, the already existing image will be reused. +Then, `make clean` will remove the VM, but not the vagrant box (in order to clean everythin, use `make cleancache`). ### Complex Example