readme: add readme

This commit is contained in:
osy 2023-07-27 15:12:04 -07:00
parent a70fc060ad
commit 77320e75e2
2 changed files with 27 additions and 0 deletions

BIN
Extras/screen.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 210 KiB

27
README.md Normal file
View file

@ -0,0 +1,27 @@
CrystalFetch
============
[![Build](https://github.com/TuringSoftware/CrystalFetch/workflows/Build/badge.svg?branch=main&event=push)][1]
CrystalFetch is a macOS application that creates Windows® 11 installer ISO images. It can be used with [UTM virtual machines][3] as well as other VM solutions.
Note: CrystalFetch is not affiliated with Microsoft and a valid license is required to install Windows® 11.
<p align="center">
<img alt="CrystalFetch logo" src="Source/Assets.xcassets/AppIcon.appiconset/icon_128x128.png" srcset="Source/Assets.xcassets/AppIcon.appiconset/icon_128x128@2x@2x.png 2x" /><br />
<img alt="CrystalFetch screenshot" src="Extras/screen.png" />
</p>
Building
--------
1. Make sure submodules are fetched with `git submodule update --init`
2. If you have a paid Apple Developer license, copy `CodeSigning.xcconfig.sample` to `CodeSigning.xcconfig` and fill out the file with your developer information.
3. If you do not have a paid Apple Developer license, you need to disable library validation. For each build target in the project, go to "Signing & Capabilities" and check "Disable Library Validation".
4. You can now build and run the project from Xcode.
Credits
-------
CrystalFetch uses [UUPDump][3] APIs and converter scripts.
[1]: https://github.com/TuringSoftware/CrystalFetch/actions?query=event%3Arelease+workflow%3ABuild
[2]: https://mac.getutm.app
[3]: https://uupdump.net