|
1 | 1 | # FuzzyOS [](https://github.com/scopeInfinity/FuzzyOS/actions?query=workflow%3ABuild) [](https://github.com/scopeInfinity/FuzzyOS/actions?query=workflow%3ATest) |
2 | 2 | Experimental OS |
3 | 3 |
|
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 |
5 | 37 |
|
6 | 38 | #### Prerequisite |
7 | 39 |
|
8 | 40 | ``` |
9 | 41 | bash before_install.sh |
10 | 42 | ``` |
11 | 43 |
|
12 | | -#### Usage |
13 | | -- Use make to build binaries and image files. |
14 | | - - `make` |
| 44 | +#### QEMU Quick Launch |
15 | 45 |
|
16 | | -##### Boot image on a VM |
17 | | -###### QEMU |
18 | | - - `make qemu` |
| 46 | +`make qemu` |
19 | 47 |
|
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 |
25 | 49 |
|
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` |
36 | 52 |
|
37 | 53 | ##### Tests |
38 | 54 |
|
|
0 commit comments