From 3acf86b17348a9c7c26b64cb92bf44f7f29376da Mon Sep 17 00:00:00 2001
From: Daniel Lublin <daniel@lublin.se>
Date: Tue, 16 Jul 2024 11:08:17 +0200
Subject: [PATCH] doc: remove outdated example in README, point to real source
 instead

The example inlined in the README seems to be for an older version of
the package. Let's not try to maintain it, pointing at the example file
instead.
---
 README.md | 44 +-------------------------------------------
 1 file changed, 1 insertion(+), 43 deletions(-)

diff --git a/README.md b/README.md
index b8280fb7..dcac9fd5 100644
--- a/README.md
+++ b/README.md
@@ -85,49 +85,7 @@ Some filesystem types are intended to be created once, after which they are read
 
 ### Example
 
-There are examples in the [examples/](./examples/) directory. Here is one to get you started.
-
-The following example will create a fully bootable EFI disk image. It assumes you have a bootable EFI file (any modern Linux kernel compiled with `CONFIG_EFI_STUB=y` will work) available.
-
-```go
-import diskfs "github.com/diskfs/go-diskfs"
-
-espSize int := 100*1024*1024 // 100 MB
-diskSize int := espSize + 4*1024*1024 // 104 MB
-
-
-// create a disk image
-diskImg := "/tmp/disk.img"
-disk := diskfs.Create(diskImg, diskSize, diskfs.Raw, diskfs.SectorSizeDefault)
-// create a partition table
-blkSize int := 512
-partitionSectors int := espSize / blkSize
-partitionStart int := 2048
-partitionEnd int := partitionSectors - partitionStart + 1
-table := PartitionTable{
-	type: partition.GPT,
-	partitions:[
-		Partition{Start: partitionStart, End: partitionEnd, Type: partition.EFISystemPartition, Name: "EFI System"}
-	]
-}
-// apply the partition table
-err = disk.Partition(table)
-
-
-/*
- * create an ESP partition with some contents
- */
-kernel, err := os.ReadFile("/some/kernel/file")
-
-fs, err := disk.CreateFilesystem(0, diskfs.TypeFat32)
-
-// make our directories
-err = fs.Mkdir("/EFI/BOOT")
-rw, err := fs.OpenFile("/EFI/BOOT/BOOTX64.EFI", os.O_CREATE|os.O_RDRWR)
-
-err = rw.Write(kernel)
-
-```
+There are examples in the [examples/](./examples/) directory. See for example how to [create a fully bootable EFI disk image](./examples/efi_create.go).
 
 ## Tests
 There are two ways to run tests: unit and integration (somewhat loosely defined).