Skip to content

Commit a0c831a

Browse files
committed
Remove wall-of-text from README and link to docs
1 parent c2aff7c commit a0c831a

File tree

1 file changed

+4
-114
lines changed

1 file changed

+4
-114
lines changed

README.md

Lines changed: 4 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -65,24 +65,11 @@ You can find the **latest DMG file** on the releases page:
6565
[![Download Fuji: DMG](https://badgen.net/static/Download%20Fuji/DMG/blue?icon=apple&scale=2)][releases]
6666

6767

68-
## Drive preparation
69-
70-
Please carefully follow the installation procedure:
71-
72-
1. Partition your destination drive using the **exFAT** file system
73-
2. Set the volume label as `Fuji`
74-
3. Download and copy the universal Fuji DMG in the drive
75-
76-
7768
## How to use Fuji
7869

79-
1. Connect the destination drive to the target Mac computer
80-
2. Open the Fuji DMG and click on _Full Disk Access Settings.url_
81-
3. If the window has a "lock" icon, unlock it
82-
4. Drag the _Fuji.app_ file on the list of authorized apps **and ensure the
83-
toggle is enabled**
84-
5. Now you can run _Fuji.app_
85-
6. When prompted, insert the password for the administrator user
70+
Please make sure to read the documentation on how to prepare your drive:
71+
72+
[![Documentation](https://badgen.net/static/color/Documentation/red?label&scale=2)][docs]
8673

8774
The following video shows the entire acquisition process, step by step:
8875

@@ -92,103 +79,6 @@ The following video shows the entire acquisition process, step by step:
9279

9380
_[Getting Started with Fuji - The Logical Choice for Mac Imaging](https://www.youtube.com/watch?v=9bEiizjySHA) on YouTube_
9481

95-
### Important notes
96-
97-
1. Before starting the acquisition, you must specify on what drive(s) you want
98-
to store the temporary sparseimage and the final DMG file. Both values are
99-
`/Volumes/Fuji` by default and the _image name_ parameter will be used to make
100-
a new directory inside those locations.
101-
102-
2. You must not save the disk images on the same drive you are acquiring!
103-
104-
3. If you want to use the Rsync mode, it is recommended to **close all other
105-
applications before proceeding, especially Apple Mail,** otherwise some data
106-
might not be collected.
107-
108-
4. After the acquisition is completed you are free to decide if you want to
109-
delete the temporary sparseimage file, or keep it. All the data is still kept
110-
in the DMG file.
111-
112-
113-
## Troubleshooting common issues
114-
115-
### ASR acquisition fails with "operation not permitted"
116-
117-
First of all, ensure that Fuji is in the list of apps with _Full Disk Access_
118-
permissions and the toggle is active. Close and re-open Fuji.
119-
120-
If the issue persists, try to acquire the _Data_ volume instead of the root
121-
volume. It is usually called **Macintosh HD - Data** and it includes all user
122-
files, settings and installed applications.
123-
124-
Fuji testers have reported that this generally solves the issue.
125-
126-
### ASR acquisition fails with error 49186 or 49197
127-
128-
This has often been reported on macOS version 13 (Ventura). The APFS volume may
129-
need to be checked using the _First Aid_ function of Disk Utility (`fsck`).
130-
131-
If this does not work, try acquiring the **Macintosh HD - Data** volume instead.
132-
133-
In some extreme cases you might need to upgrade the operating system to a newer
134-
version or perform Rsync acquisition instead.
135-
136-
The Rsync acquisition method works even on damaged file systems and can be used
137-
to acquire only a single directory instead of the whole drive. Files that cannot
138-
be read are skipped.
139-
140-
### Apple Mail data is not being acquired in Rsync mode
141-
142-
Please ensure all other apps are closed, especially Apple Mail, before using the
143-
Rsync acquisition method.
144-
145-
146-
## Development
147-
148-
Fuji is developed as a Universal2 application using the **3.10 release** of
149-
Python from [Python.org][python].
150-
151-
You can create a virtual environment with:
152-
153-
/usr/local/bin/python3.10 -m venv env
154-
source env/bin/activate
155-
156-
The DMG file can be built by using the included Pyinstaller script:
157-
158-
pip install -r requirements.txt
159-
pyinstaller Fuji.spec
160-
161-
The build process must be executed from a computer running macOS.
162-
163-
The following is a list of prerequisites if you want to modify the source code
164-
or run Fuji from source:
165-
166-
- macOS version 11 or later
167-
- Python version 3.10 (tested with [3.10.11][python310])
168-
169-
170-
## Resources
171-
172-
These are a few of several resources that have helped in the development of this
173-
software. Some include further reading on the topic:
174-
175-
- The question [How do I copy a list of folders recursively, ignoring
176-
errors?][superuser_question] has a couple of interesting leads, mentioning
177-
Rsync and Ditto.
178-
- An answer to [Can I use ditto on OS X to sync two folders on the same
179-
machine?][superuser_answer] summarizes the difference between using Ditto and
180-
Rsync, taken from the following article.
181-
- The [Guide to Backing Up Mac OS X][bombich_guide] by CCC's developer Mike
182-
Bombich includes a detailed description of Ditto, Rsync and ASR (with the
183-
purpose of creating full disk backups).
184-
- [A user’s guide to Disk Images][disk_images] describes the features of sparse
185-
bundles and sparse images.
186-
18782

18883
[releases]: https://github.com/Lazza/Fuji/releases
189-
[python]: https://python.org
190-
[python310]: https://www.python.org/downloads/release/python-31011/
191-
[superuser_question]: https://superuser.com/q/91556/278831
192-
[superuser_answer]: https://superuser.com/a/92142/278831
193-
[bombich_guide]: https://web.archive.org/web/20100107194426/http://www.bombich.com/mactips/image.html
194-
[disk_images]: https://eclecticlight.co/2022/07/11/a-users-guide-to-disk-images/
84+
[docs]: https://fujiapp.top

0 commit comments

Comments
 (0)