Skip to content

Commit 7153dcd

Browse files
Update README.md
1 parent 57ffb96 commit 7153dcd

File tree

1 file changed

+38
-22
lines changed

1 file changed

+38
-22
lines changed

README.md

Lines changed: 38 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,54 @@
11
# FuzzyOS [![Build](https://github.com/scopeInfinity/FuzzyOS/workflows/Build/badge.svg)](https://github.com/scopeInfinity/FuzzyOS/actions?query=workflow%3ABuild) [![Test](https://github.com/scopeInfinity/FuzzyOS/workflows/Test/badge.svg)](https://github.com/scopeInfinity/FuzzyOS/actions?query=workflow%3ATest)
22
Experimental OS
33

4-
- Not yet ready.
4+
- The project is still under development:exclamation:
5+
6+
### Release
7+
8+
Please find all releases at https://github.com/scopeInfinity/FuzzyOS/releases
9+
10+
The new releases should have following artifacts:
11+
- VMDK image
12+
- Test Screenshots
13+
- Source code
14+
15+
### Boot OS
16+
17+
#### How to get boot image?
18+
- Download image from one of the [Release](#Release).
19+
- Or directly build image using `make qemu` after cloning the repository.
20+
21+
#### Boot on VMware
22+
- Create *Virtual Machine Disk* with fixed size of *4MB*.
23+
- Burn `image.vmdk` to `new-disk-flat.vmdk`
24+
- `bash scripts/burn.sh /path/to/image.vmdk /path/to/build/new-disk-flat.vmdk`
25+
- Or simply replace `new-disk-flat.vmdk` with a sym-link to `build/image.vmdk` (for rapid development :grin:)
26+
27+
##### Boot on a real machine
28+
- Use `dd` or `scripts/burn.sh` to burn image into the disk (potentially destructive).
29+
- `bash scripts/burn.sh build/image.vmdk /path/to/devicefile`
30+
31+
###### If boot from Flash Drive doesn't work
32+
- Try formatting device MBR with a FAT partition.
33+
- And then burn the image again.
34+
35+
36+
### Development
537

638
#### Prerequisite
739

840
```
941
bash before_install.sh
1042
```
1143

12-
#### Usage
13-
- Use make to build binaries and image files.
14-
- `make`
44+
#### QEMU Quick Launch
1545

16-
##### Boot image on a VM
17-
###### QEMU
18-
- `make qemu`
46+
`make qemu`
1947

20-
###### VMware
21-
- Create *Virtual Machine Disk* with fixed size of *4MB*.
22-
- Burn `build/image.vmdk` to `new-disk-flat.vmdk`
23-
- `bash scripts/burn.sh build/image.vmdk /path/to/build/new-disk-flat.vmdk`
24-
- Or replace `new-disk-flat.vmdk` with a sym-link to `build/image.vmdk` :grin:
48+
#### Build
2549

26-
##### Boot image on a real machine
27-
- Use `dd` or `scripts/burn.sh` to burn image into the disk (potentially destructive).
28-
- ```
29-
bash scripts/burn.sh build/image.vmdk /path/to/devicefile
30-
```
31-
###### Issues on booting from the Flash Drive
32-
- Try formatting device MBR with a FAT partition.
33-
- And then burn it again with test image.
34-
35-
#### Development
50+
Use make to build binaries and image files.
51+
- `make`
3652

3753
##### Tests
3854

0 commit comments

Comments
 (0)