|
1 | | -# FloatNote |
| 1 | +# FloatNote 2.0 |
2 | 2 |
|
3 | 3 | English · [简体中文](README.md) |
4 | 4 |
|
5 | | -FloatNote is a lightweight, portable desktop memo for Windows. It is written in native C++/Win32 and has no network access, account, installer, or third-party runtime dependency. |
| 5 | +A portable native Windows desktop note with liquid glass, frosted glass and solid backgrounds. Text uses the native Windows editor, with selection, IME input and undo. Notes and preferences stay local. |
6 | 6 |
|
7 | | - |
| 7 | +## Download an app, not source code |
8 | 8 |
|
9 | | -## Features |
| 9 | +**[Download the latest portable release](https://github.com/Fryingpan-Jason/FloatNote/releases/latest)**, extract the ZIP, and run `FloatNote.exe`. No compiler, development tools or additional runtime installation is required. |
10 | 10 |
|
11 | | -- One persistent desktop note with automatic local saving beside the executable. |
12 | | -- Rounded glass on Windows 11 with an optional window shadow. |
13 | | -- Both modes share background opacity from 0–100%. Zero shows the desktop (blurred when glass is on); 100% covers it with the theme color. Text stays opaque. |
14 | | -- Five presets and custom RGB colors. Text color can be automatic or custom, with an option to return to automatic selection. |
15 | | -- Optional always-on-top, mouse click-through, tray menu, and startup shortcut. |
16 | | -- English and Simplified Chinese UI. Follow Windows by default or choose a language in settings or the tray menu. |
17 | | -- Per-monitor DPI, display hot-plug recovery, High Contrast, Energy Saver, and Remote Desktop fallbacks. |
18 | | - |
19 | | -## Download and use |
| 11 | +| File | Choose for | |
| 12 | +| --- | --- | |
| 13 | +| `FloatNote-2.0.0-windows-x64.zip` | Most Intel/AMD 64-bit PCs; recommended default | |
| 14 | +| `FloatNote-2.0.0-windows-arm64.zip` | Windows on ARM, including Snapdragon X devices | |
| 15 | +| `FloatNote-2.0.0-windows-x86.zip` | 32-bit environments or a required 32-bit process | |
20 | 16 |
|
21 | | -Download the matching archive from [Releases](https://github.com/Fryingpan-Jason/FloatNote/releases), extract it to a writable folder, and run `FloatNote.exe`. Avoid `Program Files`: notes and settings are stored beside the executable by default. |
| 17 | +The **Source code** links on GitHub are for developers, not ready-to-run applications. Extract into a writable folder, rather than `Program Files`. Binaries are unsigned; Windows may show a SmartScreen prompt. Compare the downloaded ZIP with `SHA256SUMS.txt` on the release page if needed. |
22 | 18 |
|
23 | | -| Archive | Devices | |
24 | | -| --- | --- | |
25 | | -| `windows-x64` | Most 64-bit Intel and AMD Windows PCs | |
26 | | -| `windows-x86` | 32-bit Windows 10 or environments that require a 32-bit app | |
27 | | -| `windows-arm64` | Windows 11 ARM devices, including Snapdragon X PCs | |
| 19 | +## What's new |
28 | 20 |
|
29 | | -Main controls: |
| 21 | +- Liquid glass with continuous edge refraction, background-responsive reflections, edge softness and adjustable dispersion. Frosted and solid modes remain available. |
| 22 | +- A compact top control expands into settings and close actions when approached, then retracts when you leave. |
| 23 | +- Shrink the note vertically to tuck it into a small status bar; click to restore. Absorption, restoration and arrival bounce share continuous geometry. |
| 24 | +- Pinning, mouse click-through, preset/custom background and text colors, font size and blur controls. |
| 25 | +- Choose between hiding to the tray and exiting when closing, and optionally remember the choice. |
| 26 | +- Single-instance behavior, startup integration and global recovery shortcuts. |
30 | 27 |
|
31 | | -- Click text to edit, drag text to select, and drag blank editor space or the top pill to move the note. |
32 | | -- Resize from the bottom-right grip. |
33 | | -- Use `Ctrl + wheel`, `Ctrl + +`, or `Ctrl + -` to change text size; `Ctrl+0` resets it to 13 pt. |
34 | | -- `Ctrl+Alt+E` shows the note and restores editing, `Ctrl+Alt+H` hides it, and `Ctrl+Alt+P` toggles mouse click-through. |
35 | | -- Double-click the tray icon or launch FloatNote again to restore editing. |
| 28 | +## Use and upgrade |
36 | 29 |
|
37 | | -## Windows version differences |
| 30 | +- Hover near the top hint to reveal settings; drag the bottom-right grip to resize. |
| 31 | +- `Ctrl+Alt+E`: show and restore editing. `Ctrl+Alt+H`: toggle visibility. `Ctrl+Alt+P`: toggle mouse click-through. |
| 32 | +- Double-click the tray icon or run the app again to recover your note. |
| 33 | +- `Ctrl+wheel`, `Ctrl++` and `Ctrl+-` change font size. |
| 34 | +- To upgrade from 1.x, exit the old app and replace `FloatNote.exe` in the same folder. **Keep the existing `data` folder**, and back it up first if you want an easy rollback. |
38 | 35 |
|
39 | | -| Environment | Behavior | |
40 | | -| --- | --- | |
41 | | -| Windows 11 | Native rounded glass and standard transparency. Glass requires Windows transparency effects. | |
42 | | -| Windows 10 1809–22H2 | Standard transparency is supported. Glass falls back; native rounded glass is not promised. | |
43 | | -| Earlier than Windows 10 | Unsupported. | |
44 | | -| High Contrast | Uses opaque system colors and system text colors. | |
45 | | -| Energy Saver / Remote Desktop | Pauses glass and uses the standard background to reduce cost or avoid compositor differences. | |
| 36 | +Archives contain no note data or personal settings. The app creates `data/note.txt`, `settings.ini`, `material.ini` and `experience.ini` locally. It has no accounts, telemetry or network client. Screen pixels used for glass are processed locally through Windows APIs and the GPU, never uploaded. |
46 | 37 |
|
47 | | -See [Compatibility](docs/COMPATIBILITY.md) for tested boundaries and caveats. |
| 38 | +## Platform and language limits |
48 | 39 |
|
49 | | -## Data and privacy |
| 40 | +Liquid glass is intended for supported Windows 11 capture/composition environments. Accessibility, power, remote-session and API limitations can trigger fallback; see [compatibility](docs/COMPATIBILITY.md). The live liquid-glass note can be absent from screenshots or third-party remote streams; choose frosted glass when capture visibility matters. The top control is drawn independently as a recovery route. |
50 | 41 |
|
51 | | -FloatNote has no network access or telemetry. `data/note.txt` is UTF-8 text, and `data/settings.ini` stores window and appearance preferences. Writes use a temporary file followed by an atomic replacement. Read and save failures preserve the original note instead of replacing it with an error message. |
| 42 | +**The new 2.0 settings panel, close prompt and material controls are currently in Chinese.** Existing tray and basic UI language options remain available. A complete English translation of the new panel is not claimed for this release. |
52 | 43 |
|
53 | 44 | ## Build |
54 | 45 |
|
55 | | -Visual Studio C++ tools and the Windows 10/11 SDK are required: |
| 46 | +With Visual Studio C++ tools and a Windows SDK, the default build produces the 2.0 desktop app: |
56 | 47 |
|
57 | 48 | ```powershell |
58 | | -.\build.ps1 -Architecture x64 |
59 | | -.\build.ps1 -Architecture x86 -OutputDirectory build\x86 |
| 49 | +.\build.ps1 -Architecture x64 -OutputDirectory build\x64 |
60 | 50 | .\build.ps1 -Test -OutputDirectory build\tests |
| 51 | +.\scripts\package.ps1 -Architecture x64 |
61 | 52 | ``` |
62 | 53 |
|
63 | | -ARM64 can be built with Visual Studio ARM64 C++ tools or on GitHub's Windows 11 ARM runner. See [Development](docs/DEVELOPMENT.md) for the build, test, and release flow. |
64 | | - |
65 | | -## Contributing |
66 | | - |
67 | | -Issues and pull requests are welcome. Read [CONTRIBUTING.md](CONTRIBUTING.md) first. FloatNote is available under the [MIT License](LICENSE). |
| 54 | +See [development](docs/DEVELOPMENT.md). MIT licensed; adapted material code is credited in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). |
0 commit comments