Skip to content

Commit e2ed0fe

Browse files
RavbugRavbug
authored
Add website (#1)
1 parent 6c32fcd commit e2ed0fe

File tree

6 files changed

+148
-37
lines changed

6 files changed

+148
-37
lines changed

‎.github/workflows/build.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
name: Build-App
2-
on: push
2+
on:
3+
push:
4+
paths-ignore:
5+
- README.md
6+
- _site/*
7+
- ".github/workflows/website.yml"
38

49
jobs:
510
build-linux:

‎.github/workflows/website.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Build-Website
2+
on: push
3+
4+
jobs:
5+
build-site:
6+
name: Build Website
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout code
10+
uses: actions/checkout@v3
11+
with:
12+
submodules: true
13+
- name: Fix permissions
14+
run: |
15+
chmod -c -R +rX "_site/" | while read line; do
16+
echo "::warning title=Invalid file permissions automatically fixed::$line"
17+
done
18+
- name: Upload
19+
uses: actions/upload-pages-artifact@v2
20+
21+
# Deploy job
22+
deploy:
23+
# Add a dependency to the build job
24+
needs: build-site
25+
26+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
27+
permissions:
28+
pages: write # to deploy to Pages
29+
id-token: write # to verify the deployment originates from an appropriate source
30+
31+
# Deploy to the github-pages environment
32+
environment:
33+
name: github-pages
34+
url: ${{ steps.deployment.outputs.page_url }}
35+
36+
# Specify runner + deployment step
37+
runs-on: ubuntu-latest
38+
steps:
39+
- name: Deploy to GitHub Pages
40+
id: deployment
41+
uses: actions/deploy-pages@v2 # or the latest "vX.X.X" version tag for this action

‎README.md

Lines changed: 3 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,11 @@
1-
# FatFileFinder C++ edition
1+
# FatFileFinder
22

33
## Information
44
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.
55
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.
6-
Similar to [WinDirStat](https://windirstat.net/), but lighter, faster, and uses a background thread.
6+
Similar to [WinDirStat](https://windirstat.net/), but lighter and faster.
77

8-
## How to Install
9-
1. Ensure your system meets the minimum requirements:
10-
- macOS 10.15 or higher (I cannot support 10.14 or lower because of unsupported STL features, sorry!)
11-
- Windows 10 or higher
12-
- 64 bit linux with GTK+ (32 bit users must compile their own copy)
13-
2. Download the executable from the [releases](https://github.com/Ravbug/FatFileFinderCPP/releases/latest) tab
14-
- To download the latest beta build, visit the [Actions](https://github.com/Ravbug/FatFileFinderCPP/actions/workflows/build.yml) tab.
15-
4. The program is a self-contained executable. Store it anywhere on your disk.
16-
- Recommended locations:
17-
- macOS: `/Applications`
18-
- Windows: `\Program Files`
19-
- Linux: `/usr/bin`
20-
5. Run the program by double-clicking it.
21-
22-
## How to Size a Folder
23-
1. Click the folder button (📁) in the toolbar to choose a folder or drive.
24-
2. The program will begin sizing the folder and updating the view.
25-
3. To stop sizing early, press the 🛑 button at the bottom of the window.
26-
27-
## Other Usage info
28-
* Single click rows in the table to view their properties in the sidebar. Click a disclosure triangle to open a folder.
29-
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.
30-
* To refresh a folder, select it in the table and press the refresh button (🔁). The program will refresh the contents of that folder.
31-
If you want to reload the root folder, you will have to re-size it using the 📁 button.
32-
* To view an item in your system's file browser, select it in the view and press `Reveal in Explorer/Finder` in the sidebar.
33-
* To copy the full path to an item, select it in the view and press `Copy Path` in the sidebar.
34-
35-
Note: Clipboard is currently not available on macOS. The sidebar in the Windows version is different from that on macOS and Linux.
36-
The Windows version currently does not support the emoji icons.
37-
38-
## Screenshots
39-
![Main Window](https://user-images.githubusercontent.com/22283943/74867349-84c94d80-5322-11ea-8e75-9539b45d889a.png)
40-
41-
## Compiling it yourself
8+
## Building
429
Use CMake:
4310
```sh
4411
mkdir -p build && cd build

‎_site/favicon.png

3.11 KB
Loading

‎_site/index.html

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<head>
2+
<title>FatFileFinder</title>
3+
<link rel="stylesheet" type="text/css" href="style.css">
4+
<meta charset="utf-8">
5+
<meta name="description" content="Fast, native disk sweeper for Windows, Mac, and Linux">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<link id="favicon" rel="icon" href="favicon.png" type="image/x-icon">
8+
9+
<meta property="og:image" content="https://www.ravbug.com/FatFileFinder/favicon.png">
10+
<meta property="og:image:type" content="image/png">
11+
<meta property="og:image:width" content="128">
12+
<meta property="og:image:height" content="128">
13+
</head>
14+
<body>
15+
<h1>FatFileFinder</h1>
16+
<p>
17+
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.
18+
Similar to <a href="https://windirstat.net/">WinDirStat</a> but lighter and faster.
19+
</p>
20+
<img class="heroimage" src="https://user-images.githubusercontent.com/22283943/74867349-84c94d80-5322-11ea-8e75-9539b45d889a.png">
21+
22+
<h3>Usage</h3>
23+
<p>
24+
<ul>
25+
<li>
26+
Click the folder button (📁) in the toolbar to choose a folder or drive. The program will begin sizing the folder and updating the view.
27+
</li>
28+
<li>
29+
To stop sizing early, press the 🛑 button at the bottom of the window.
30+
</li>
31+
<li>
32+
Single click rows in the table to view their properties in the sidebar. Click a disclosure triangle to open a folder.
33+
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.
34+
</li>
35+
<li>
36+
To refresh a folder, select it in the table and press the refresh button (🔁). The program will refresh the contents of that folder.
37+
</li>
38+
<li>
39+
If you want to reload the root folder, you will have to re-size it using the 📁 button.
40+
</li>
41+
<li>
42+
To view an item in your system's file browser, select it in the view and press `Reveal in Explorer/Finder` in the sidebar.
43+
</li>
44+
<li>
45+
To copy the full path to an item, select it in the view and press `Copy Path` in the sidebar.
46+
</li>
47+
<li>
48+
FatFileFinder does <emp>not</emp> delete files. You must delete them manually yourself.
49+
</li>
50+
</ul>
51+
</p>
52+
Note: The Windows version currently does not support the emoji icons.
53+
54+
<h3>Supported Platforms</h3>
55+
<ol>
56+
<li>
57+
macOS 10.15 or higher
58+
</li>
59+
<li>
60+
Windows 10 or higher
61+
</li>
62+
<li>
63+
64 bit linux x86_64 with GTK+ (Other configurations must compile their own copy)
64+
</li>
65+
</ol>
66+
67+
<h2><a href="https://github.com/Ravbug/FatFileFinder/releases/latest">Download</a></h2>
68+
<p>
69+
The program is a self-contained executable. Store it anywhere on your disk. Recommended locations:
70+
<ul>
71+
<li>macOS: /Applications</li>
72+
<li>Windows: \Program Files</li>
73+
<li>Linux: /usr/bin</li>
74+
</ul>
75+
</p>
76+
77+
<h3><a href="https://github.com/Ravbug/FatFileFinder">Source code</a></h3>
78+
</body>

‎_site/style.css

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
*{
2+
font-family: system-ui
3+
}
4+
@media (prefers-color-scheme: dark) {
5+
body{
6+
background-color: #323232;
7+
color: white;
8+
}
9+
a{
10+
color: rgb(83, 158, 250)
11+
}
12+
}
13+
pre{
14+
font-family: monospace;
15+
overflow: scroll;
16+
}
17+
.heroimage{
18+
width: 100%;
19+
max-width: 800px;
20+
}

0 commit comments

Comments
 (0)