tauri-apps/archived-smoke-tests
1
0
Fork 0
mirror of https://github.com/tauri-apps/smoke-tests.git synced 2026-01-31 00:35:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(readme) clarifications and styling

Browse Source 
Signed-off-by: Daniel Thompson-Yvetot <denjell@quasar.dev>
This commit is contained in:
Daniel Thompson-Yvetot
2019-07-13 22:53:44 +02:00
committed by Ty
parent 578fe69b79
commit 7995b91fb8
1 changed files with 78 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
packages/create-react-app/README.md
View File

@@ -18,25 +18,77 @@ Whether you are just starting out making apps for your meetup or
regularly crunch terabyte datasets, we are absolutely confident that
you will love using Proton as much as we love making and maintaining it.
It leverages Cocoa/WebKit on macOS, gtk-webkit2 on Linux and MSHTML
(IE10/11) or Webkit via Edge on Windows. **Proton** is based on the
MIT licensed prior work known as [webview](https://github.com/zserge/webview).
The default binding to the underlying webview library uses Rust, but
other languages are possible (and only a PR away).
## Who Proton is For
Anyone who can create a Quasar app can use Proton, as it is *merely* a new
build target. All components and plugins (suitable for Native Desktop) can
be used. For the User Interface, nothing has changed, except you will
probably notice that everything seems much faster.
Because of the way Proton has been built and can be extended, developers
are able to interface not only with the entire Rust ecosystem, but also
with many other programming languages. Being freed of the heaviest thing
in the universe and the many shortcomings of server-side Javascript
suddenly opens up whole new avenues for high-performance, security-focused
applications that need the purebred power, agility and community
acceptance of a low-level language.
We expect to witness an entire new class of applications being built with
Quasar Proton. From a simple calender to locally crunching massive realtime
feeds at particle colliders or even mesh-network based distributed message-
passing ecosystems - the bar has been raised and gauntlet thrown.
What will you make?
## Technical Details
The user interface in Proton apps currently leverages Cocoa/WebKit on macOS,
gtk-webkit2 on Linux and MSHTML (IE10/11) or Webkit via Edge on Windows.
**Proton** is based on the MIT licensed prior work known as
[webview](https://github.com/zserge/webview).
The default binding to the underlying webview library currently uses Rust,
but other languages like Golang or Python (and many others) are possible
(and only a PR away).
> Rust is blazingly fast and memory-efficient: with no runtime or garbage
collector, it can power performance-critical services, run on embedded
devices, and easily integrate with other languages. Rust’s rich type system
and ownership model guarantee memory-safety and thread-safety — and enable
you to eliminate many classes of bugs at compile-time. Rust has great
documentation, a friendly compiler with useful error messages, and top-notch
tooling — an integrated package manager and build tool, smart multi-editor
support with auto-completion and type inspections, an auto-formatter, and
more. - [https://www.rust-lang.org/](https://www.rust-lang.org/)
This combination of power, safety and usability are why we chose Rust to be
the default binding for Proton. It is our intention to provide the most safe
and performant native app experience (for devs and app consumers), out of
the box.
### Current Status
We are in the process of vetting this new mode. It is not yet available to
use without jumping through some development hurdles. If you don't care,
please reach out to the team at https://chat.quasar.dev and we'll guide
you through the process.
you through the process. Here is a bit of a status report.
### Comparison between Proton and Electron
- [x] Promise based File System Access
- [x] App Icons and integration with Icon-Genie
- [ ] Frameless Mode
- [x] Build on MacOS
- [x] Build on Linux
- [ ] Build on Windows
- [x] STDOUT Passthrough with Command Invocation
- [x] Self Updater
- [x] Inter Process Communication (IPC)
- [x] Documentation
### Comparison between Proton 1 and Electron 5
| | Proton | Electron |
|--|--------|----------|
| Binary Size MacOS | 3.6 MB | 148.7 MB |
| Memory Consumption MacOS | 13 MB | 34.1 MB |
| Benchmark FPS † | TODO | TODO |
| Benchmark FPS | TODO | TODO |
| Interface Service Provider | Varies | Chromium |
| Quasar UI | VueJS | VueJS |
| Backend Binding | Rust | Node.js (ECMAScript) |
@@ -44,8 +96,9 @@ you through the process.
| FLOSS | Yes | No |
| Multithreading | Yes | No |
| Bytecode Delivery | Yes | No |
| Multiple Windows | Yes | Yes |
| Can Render PDF | Yes | No |
| Multiple Windows | Yes | Yes |
| GPU Access | Yes | Yes |
| Updater | Yes | Yes |
| Inter Process Communication (IPC) | Yes | Yes |
| Cross Platform | Yes | Yes |
@@ -68,33 +121,40 @@ honoured to carry the torch further. Of special note:
- [Boscop](https://github.com/Boscop) for the Rust Bindings
## Documentation
Head over to the Quasar Framework official website: [https://quasar.dev](https://quasar.dev)
Head over to the Quasar Framework official website:
[https://quasar.dev](https://quasar.dev)
## Stay in Touch
For latest releases and announcements, follow on Twitter: [@quasarframework](https://twitter.com/quasarframework)
For latest releases and announcements, follow on Twitter:
[@quasarframework](https://twitter.com/quasarframework)
## Chat Support
Get realtime help at the official community Discord server: [https://chat.quasar.dev](https://chat.quasar.dev)
Get realtime help at the official community Discord server:
[https://chat.quasar.dev](https://chat.quasar.dev)
## Community Forum
Ask complicated questions at the official community forum: [https://forum.quasar.dev](https://forum.quasar.dev)
Ask complicated questions at the official community forum:
[https://forum.quasar.dev](https://forum.quasar.dev)
## Contributing
Please make sure to read the [Contributing Guide](./.github/CONTRIBUTING.md) before making a pull request. If you have a Quasar-related project/component/tool, add it with a pull request to [this curated list](https://github.com/quasarframework/quasar-awesome)!
Please make sure to read the [Contributing Guide](./.github/CONTRIBUTING.md)
before making a pull request. If you have a Quasar-related
project/component/tool, add it with a pull request to
[this curated list](https://github.com/quasarframework/quasar-awesome)!
Thank you to all the people who already <a href="https://github.com/quasarframework/quasar/graphs/contributors">contributed to Proton</a>!
Thank you to all the people who already <a href="https://github.com/quasarframework/proton/graphs/contributors">contributed to Proton</a>!
## Semver
Quasar is following [Semantic Versioning 2.0](https://semver.org/).
quasarframework/proton is following [Semantic Versioning 2.0](https://semver.org/).
## Licenses
Code: (c) 2019 - Daniel Thompson-Yvetot, Razvan Stoenescu, Lucas Nogueira.
MIT and where applicable Apache
Logo: CC-BY-NC-ND
Original Proton Logo Design by [Daniel Thompson-Yvetot](https://github.com/nothingismagick)
Based on the prior work by [Emanuele Bertoldi](https://github.com/zuck)
- Original Proton Logo Design by [Daniel Thompson-Yvetot](https://github.com/nothingismagick)
- Based on the prior work by [Emanuele Bertoldi](https://github.com/zuck)
Note: This license notice will not be complete until we have performed an
upstream audit. If you feel that your name should be listed here, please