Skip to content

Commit

Permalink
Other: Updated manual and README files
Browse files Browse the repository at this point in the history
  • Loading branch information
vashpan committed Oct 19, 2022
1 parent cc445a6 commit 9d8e5ad
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
13 changes: 9 additions & 4 deletions DevCleaner/Resources/Manual/manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,19 @@ <h4>Derived Data</h4>
<p>When you develop your app, Xcode caches your symbols, dependencies, logs, text - all to develop fast and to keep code completion working. Unfortunately this data tend to take a lot of space, especially for big projects. Also, they're not deleted automatically. This may be especially problematic if you open a lot of various projects.</p>
<p>Removing derived data is not harmful as Xcode can recreate them when you open project again. Although it's not recommended for projects that you work on often. For this reason nothing is selected by default.</p>

<h4>Documentation Cache</h4>
<p>Modern Xcodes are caching documentation that is accessed via the web. Unfortunately older caches are not cleaned up by Xcode and significant
amount of space may be wasted due to that.</p>
<p>Removing all cache is not harmful but remember that your most current Xcode will regenerate it anyway if it'll have a chance. It also could slow down access to documentation after cleaning them.</p>

<h4>Old Simulator & Device Logs</h4>
<p>Each version of Xcode appears to have a new version of database that holds logs from devices & simulators. Those databases are migrated with content of the previous ones. If you use Xcode for a long time, it would accumulate to significant amount of unused data.</p>

<p>It should be safe to check this option, by default all old databses are selected except most recent version of Xcode.</p>
<p><b>If you have multiple (older) Xcode installations, you probably should deselect those versions too.</b></p>

<h4>Old Documentation Downloads</h4>
<p>For some time, recent versions of Xcode are using online help. But if you used Xcode in the past, you may still have documentation downloaded locally to your computer. It could take a lot of space and currently there is no use for it.</p>
<p>Recent versions of Xcode are using online help. But if you used Xcode in the past, you may still have documentation downloaded locally to your computer. It could take a lot of space and currently there is no use for it.</p>

<h3>Main Window</h3>
<p>This is the main interface of the application, you select here what you want to clean and performing cleaning itself. You can also <b>share or tip me</b> if you want &#128526;</p>
Expand Down Expand Up @@ -123,14 +128,14 @@ <h4>Usage</h4>

OVERVIEW: Reclaims storage that Xcode stores in caches and old files

USAGE: DevCleaner <command> [options]
USAGE: dev-cleaner <command> [options]

OPTIONS:

info
Show all items available to clean.
clean <all,device-support,archives,derived-data,old-logs,old-documentation>
Perform cleaning of given items. Available options: all,device-support,archives,derived-data,previews,old-logs,old-documentation. If you want to clean all, pass "all"
clean <all,device-support,archives,derived-data,docs-cache,old-logs,old-documentation>
Perform cleaning of given items. Available options: all,device-support,archives,derived-data,docs-cache,previews,old-logs,old-documentation. If you want to clean all, pass "all" or nothing
--help
Prints this message
</pre>
Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![Main Window Screenshot](https://github.com/vashpan/xcode-cleaner/raw/master/Documentation/Main%20Window%20Screenshot.png)

*Currently tested with macOS 12 and Xcode 13. Should support earlier Xcode versions as well*
*Currently tested with macOS 12.x and Xcode 14.x. Should support earlier Xcode versions as well*

Available on the [Mac App Store](https://itunes.apple.com/app/devcleaner/id1388020431)

Expand Down Expand Up @@ -40,6 +40,11 @@ This is the major "cache" part of Xcode files, where autocompletion data, logs,
The point is that it could be regenerated if necessary. Also some older projects could be removed completely because its rather unusual that
we would use them again.

### Documentation Cache

Modern Xcodes are caching documentation that is accessed via the web. Unfortunately older caches are not cleaned up by Xcode and significant
amount of space may be wasted due to that.

### Old Simulator & Device Logs

Old device logs & crashes databases, only most recent ones are needed. It seems that new versions of Xcodes migrates old logs database, but keeping older ones on disk.
Expand All @@ -59,8 +64,10 @@ Website: http://www.one-minute-games.com

## Contribution

This application is my first macOS app, so feel free to give me some feedback or pull requests! If there's some new feature to support, maybe some caches I missed, let me know as well in issues.
This application is my first macOS app, so feel free to give me some feedback or pull requests! If there's some new feature to support,
maybe some caches I missed, let me know as well in issues.

Application is licensed using GPL3. You may freely modify, download, redistribute and use this application from this source code, but only me, as copyright holder can submit it to the Mac App Store.
Application is licensed using GPL3. You may freely modify, download, redistribute and use this application from this source code, but only me,
as copyright holder can submit it to the Mac App Store.

Copyright © 2018-2022 One Minute Games Konrad Kołakowski.

0 comments on commit 9d8e5ad

Please sign in to comment.