Skip to content

Commit

Permalink
Add website
Browse files Browse the repository at this point in the history
  • Loading branch information
Ravbug committed Nov 1, 2023
1 parent 6c32fcd commit 6115edc
Show file tree
Hide file tree
Showing 6 changed files with 148 additions and 37 deletions.
7 changes: 6 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
name: Build-App
on: push
on:
push:
paths-ignore:
- README.md
- _site/*
- ".github/workflows/website.yml"

jobs:
build-linux:
Expand Down
41 changes: 41 additions & 0 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Build-Website
on: push

jobs:
build-site:
name: Build Website
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
with:
submodules: true
- name: Fix permissions
run: |
chmod -c -R +rX "_site/" | while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
- name: Upload
uses: actions/upload-pages-artifact@v2

# Deploy job
deploy:
# Add a dependency to the build job
needs: build-site

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2 # or the latest "vX.X.X" version tag for this action
39 changes: 3 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,11 @@
# FatFileFinder C++ edition
# FatFileFinder

## Information
This cross-platform app sweeps a folder or drive and displays the size of each item in the folder, to assist the user in cleaning their drive.
This version is a rewrite of my [Windows-only version](https://github.com/Ravbug/FatFileFinder) in C++, using the [wxWidgets](https://www.wxwidgets.org) library for GUI.
Similar to [WinDirStat](https://windirstat.net/), but lighter, faster, and uses a background thread.
Similar to [WinDirStat](https://windirstat.net/), but lighter and faster.

## How to Install
1. Ensure your system meets the minimum requirements:
- macOS 10.15 or higher (I cannot support 10.14 or lower because of unsupported STL features, sorry!)
- Windows 10 or higher
- 64 bit linux with GTK+ (32 bit users must compile their own copy)
2. Download the executable from the [releases](https://github.com/Ravbug/FatFileFinderCPP/releases/latest) tab
- To download the latest beta build, visit the [Actions](https://github.com/Ravbug/FatFileFinderCPP/actions/workflows/build.yml) tab.
4. The program is a self-contained executable. Store it anywhere on your disk.
- Recommended locations:
- macOS: `/Applications`
- Windows: `\Program Files`
- Linux: `/usr/bin`
5. Run the program by double-clicking it.

## How to Size a Folder
1. Click the folder button (📁) in the toolbar to choose a folder or drive.
2. The program will begin sizing the folder and updating the view.
3. To stop sizing early, press the 🛑 button at the bottom of the window.

## Other Usage info
* Single click rows in the table to view their properties in the sidebar. Click a disclosure triangle to open a folder.
You can also use the up and down arrows to move the selection. Note that expanding a folder with a lot of immediate sub-items can take a moment.
* To refresh a folder, select it in the table and press the refresh button (🔁). The program will refresh the contents of that folder.
If you want to reload the root folder, you will have to re-size it using the 📁 button.
* To view an item in your system's file browser, select it in the view and press `Reveal in Explorer/Finder` in the sidebar.
* To copy the full path to an item, select it in the view and press `Copy Path` in the sidebar.

Note: Clipboard is currently not available on macOS. The sidebar in the Windows version is different from that on macOS and Linux.
The Windows version currently does not support the emoji icons.

## Screenshots
![Main Window](https://user-images.githubusercontent.com/22283943/74867349-84c94d80-5322-11ea-8e75-9539b45d889a.png)

## Compiling it yourself
## Building
Use CMake:
```sh
mkdir -p build && cd build
Expand Down
Binary file added _site/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
78 changes: 78 additions & 0 deletions _site/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
<head>
<title>FatFileFinder</title>
<link rel="stylesheet" type="text/css" href="style.css">
<meta charset="utf-8">
<meta name="description" content="Fast, native disk sweeper for Windows, Mac, and Linux">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link id="favicon" rel="icon" href="favicon.png" type="image/x-icon">

<meta property="og:image" content="https://www.ravbug.com/FatFileFinder/favicon.png">
<meta property="og:image:type" content="image/png">
<meta property="og:image:width" content="128">
<meta property="og:image:height" content="128">
</head>
<body>
<h1>FatFileFinder</h1>
<p>
This cross-platform app sweeps a folder or drive and displays the size of each item in the folder, to assist the user in cleaning their drive.
Similar to <a href="https://windirstat.net/">WinDirStat</a> but lighter and faster.
</p>
<img class="heroimage" src="https://user-images.githubusercontent.com/22283943/74867349-84c94d80-5322-11ea-8e75-9539b45d889a.png">

<h3>Usage</h3>
<p>
<ul>
<li>
Click the folder button (📁) in the toolbar to choose a folder or drive. The program will begin sizing the folder and updating the view.
</li>
<li>
To stop sizing early, press the 🛑 button at the bottom of the window.
</li>
<li>
Single click rows in the table to view their properties in the sidebar. Click a disclosure triangle to open a folder.
You can also use the up and down arrows to move the selection. Note that expanding a folder with a lot of immediate sub-items can take a moment.
</li>
<li>
To refresh a folder, select it in the table and press the refresh button (🔁). The program will refresh the contents of that folder.
</li>
<li>
If you want to reload the root folder, you will have to re-size it using the 📁 button.
</li>
<li>
To view an item in your system's file browser, select it in the view and press `Reveal in Explorer/Finder` in the sidebar.
</li>
<li>
To copy the full path to an item, select it in the view and press `Copy Path` in the sidebar.
</li>
<li>
FatFileFinder does <emp>not</emp> delete files. You must delete them manually yourself.
</li>
</ul>
</p>
Note: The Windows version currently does not support the emoji icons.

<h3>Supported Platforms</h3>
<ol>
<li>
macOS 10.15 or higher
</li>
<li>
Windows 10 or higher
</li>
<li>
64 bit linux x86_64 with GTK+ (Other configurations must compile their own copy)
</li>
</ol>

<h2><a href="https://github.com/Ravbug/FatFileFinder/releases/latest">Download</a></h2>
<p>
The program is a self-contained executable. Store it anywhere on your disk. Recommended locations:
<ul>
<li>macOS: /Applications</li>
<li>Windows: \Program Files</li>
<li>Linux: /usr/bin</li>
</ul>
</p>

<h3><a href="https://github.com/Ravbug/FatFileFinder">Source code</a></h3>
</body>
20 changes: 20 additions & 0 deletions _site/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
*{
font-family: system-ui
}
@media (prefers-color-scheme: dark) {
body{
background-color: #323232;
color: white;
}
a{
color: rgb(83, 158, 250)
}
}
pre{
font-family: monospace;
overflow: scroll;
}
.heroimage{
width: 100%;
max-width: 800px;
}

0 comments on commit 6115edc

Please sign in to comment.