From 6115edc0b243b3ca78cef571931ece3bc2d7c5b2 Mon Sep 17 00:00:00 2001 From: Ravbug Date: Wed, 1 Nov 2023 12:18:14 -0400 Subject: [PATCH] Add website --- .github/workflows/build.yml | 7 ++- .github/workflows/website.yml | 41 ++++++++++++++++++ README.md | 39 ++--------------- _site/favicon.png | Bin 0 -> 3187 bytes _site/index.html | 78 ++++++++++++++++++++++++++++++++++ _site/style.css | 20 +++++++++ 6 files changed, 148 insertions(+), 37 deletions(-) create mode 100644 .github/workflows/website.yml create mode 100644 _site/favicon.png create mode 100644 _site/index.html create mode 100644 _site/style.css diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c5a61394..a7040936 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,5 +1,10 @@ name: Build-App -on: push +on: + push: + paths-ignore: + - README.md + - _site/* + - ".github/workflows/website.yml" jobs: build-linux: diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml new file mode 100644 index 00000000..86a584f6 --- /dev/null +++ b/.github/workflows/website.yml @@ -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 \ No newline at end of file diff --git a/README.md b/README.md index 688a5421..9ab8e7e5 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/_site/favicon.png b/_site/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..02f8f64962d731e42a122a87b6167e77fd3fc86a GIT binary patch literal 3187 zcmai1`9Bkm8{cMQhhvT$S#5G9Ay<)N6>{a+a_6i_Do3tDW^TfkD@PH^S#F}tF-Nh| z<&K%c_{>#dGWPZP2R`4|^Ln25>-By;&-?k|dH?bxSzBHdfFFbd0003~6GPlS68=pn z?|!A~dkpRauc!G%Ljd>RC~7au*k@q=CXRRaCr1BG;Q6EZVE_QXsHx$(%V87C1-|~7 z!%~F8hBxC^OfZ))NyO$bsb1&jume?&T_B=D(E%0P%h(uVxh*{Y*>LQl4)lVa9he_P zENXlLx=?(C$onbK+hUojX^7Co+Hhhs^GKTo!wC3fGEPU^3)kXq$8&0%xXWbQ?)c~y4iCO zsDg#Y(*`t_mCiO^KH?RmUTuRxH>uFuToK5?HK7g}k4kB(bevd)N>*p7TOn=@SdDuZ z*9Izwaj#g-XbCmW-8wdM0OP=j8FL8<%avHm7d4>0=ItzYyT0b7|3#S%kmR+S;wiV? zoQxfpOY;Sa#ih^CD{5}5egTz3(Va-OW{wS_=wQVA`boQ6+xgcK1}@b zgBP+zjG=;B)cYTMgu*o)`>hOEQKhcu zpacnNz9W2xy^IV3rU;^DR^o?4ZLZ zjx3m#-8-Wdp&S-GpU7iHd8DbL7i(wS-h6;Fk|rRuQrXb%vYg1m&OL0bul=J-xg|Nf zgHpt7{K9h>X|f!hk1Jmr3amwLn*VSWcAwe|Jv`xfJG^QnQRJdfgrUo@Pa7UY0DexT zweB9Js=i!vRZyb9wSo5|;127I7Zux0Ew3t06&qfT{ZVcsAc#-chzjFK<0j_;Z%hG7NOSrFPjIa!#nr!oJ)E4jNVrulh zrKd;UJ(cMSizWCzx{1ZwI6mB2V|>j@sc#5|tZAHFiMYGeoM)r!{m?%^Fn;D@5>LK- zc|~b)<6YS1WI{l2m@v=rxd+>kuguCfN=3AwJ&|!-n%W2`Ot^mS)wimb{Uc~U6v~zL zy4=OMO)(msllW3yt}gyd9+Xm(%)0qlCa$0@Fkmy}{0Z7wAlm2tsNBQH3>!#+|CQtx zk)Zw{|J}};X_ z26IDpz&McA{BhUX0%Y19QS4!p4uLR<8=CKVi@`Q_igqa(YUY2HARUun5@hiz@+UCz z${l@h5jf@tODwC``i>Bu_dyF3gXm9(Gy_~h?4lK-k^a2|CpcGPYtmj~Z(Umq)<9>N zw@M}Ydq-4(y;YyRuGo@iUJcgpGFfb96%_AQLT6fjxZgVwi6UNF>Gn(QQ^+%`bnv8= zk@8*sFnHafn$riqte$Z0eyuTXT=*d1P+we%v4$wOr%70UbwnJGzw0;{3335`Cl-b% zp1-w;qVSjvs7qbqUl6rS98~hM_OmBScE6-wUl2P`jv)*soU1>v{Ip?>diFzv*+AC~ z3f`kml12%Gythekp$#dhzVXnhOX3MQsmr!vtb7zA4LseT0w2B0M5os>;r@*JD7C~? z!f-y#FFL)K-*i_!4n~*0;NwvkDQO?Ka~bAY7r#2_>KJ5!_~bKRMi+V;lW$+GH^>oZ zJJ9x=53w(RqLuW@nCLbbi=T3h$9)~OS7FI0L|^*S{ixniY(!{-qOSEsMw2l#eKOwG z|1%);Re`cC@S4X&j7c3uk8$dhqGkMKsFpoQburZp32d5dxSMQw6X>+SS(_#Bm1Z`V&NsnU<+z{|qj_z7x z59Q}1o}Chfn(fP-R8}LL(RpxiExv!ySWUA7qJJLCb+AwuZvQ5kyu>Of@y(p(BgOeh zK^M12E8h-qzAnu0^lZd1%jeTm6ug8SmL~P1g;yB*(H6M-vL@m$u48)Pt22ea-m)f# zV$f)Wy3OtQ4I(AL@^vk` ziJVQ^x8)}~JR7o@+ga=$LwD+Hy8x1rNX~qFNX8BLv+K_`)D>>WUNHC1*Z{bV3Kqwv zv}e0_?B72YZ9u;9O`p`hWP)dI0lKLvC?FI~P*C)E-b*8^`OEUPufV$fB@4%EqAWPG zs~bm=3gkySpjylr10PuF2tv`cuV?C@zr}RY5f2bjsa35_{v3ho zwB;?I+h!2^~p?KI)lz3Dw&cEE?iU>KKmkGj2AU#udrhfO3l1W=AF{=n3vXc+fA&E1(LxUh`n;TUy0_3EdeNXwCEpovQ*?7eW!mK?FJ<0x}CM~ zR&Qa8ud3f|>^68^nOwi&k~)zNYJ4Tg5@-f|3Wl8%q{}f=HcFYx3u5Nb0WeqL~^8K}wV`ochoy5cV-IB|+ zImmLrOT#yRd2#);DC5$fluDa8EQA@D#5_Ik!blKDOE zpj9Gb1_ye-Y81F)elXQj2JuDWUCiR|jeO=f+n_A?a8@@i548U?08EW64PTviC;ksB CIsL%^ literal 0 HcmV?d00001 diff --git a/_site/index.html b/_site/index.html new file mode 100644 index 00000000..0ae250e9 --- /dev/null +++ b/_site/index.html @@ -0,0 +1,78 @@ + + FatFileFinder + + + + + + + + + + + + +

FatFileFinder

+

+ 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 WinDirStat but lighter and faster. +

+ + +

Usage

+

+

    +
  • + Click the folder button (📁) in the toolbar to choose a folder or drive. The program will begin sizing the folder and updating the view. +
    • +
  • + To stop sizing early, press the 🛑 button at the bottom of the window. +
    • +
  • + 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. +
    • +
  • + FatFileFinder does not delete files. You must delete them manually yourself. +
    • +
+

+ Note: The Windows version currently does not support the emoji icons. + +

Supported Platforms

+
    +
  1. + macOS 10.15 or higher +
    2. +
  2. + Windows 10 or higher +
    3. +
  3. + 64 bit linux x86_64 with GTK+ (Other configurations must compile their own copy) +
    4. +
+ +

Download

+

+ The program is a self-contained executable. Store it anywhere on your disk. Recommended locations: +

    +
  • macOS: /Applications
    • +
  • Windows: \Program Files
    • +
  • Linux: /usr/bin
    • +
+

+ +

Source code

+ \ No newline at end of file diff --git a/_site/style.css b/_site/style.css new file mode 100644 index 00000000..71e3611d --- /dev/null +++ b/_site/style.css @@ -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; +} \ No newline at end of file