diff --git a/README.md b/README.md index 4a37d80ca..0ac4d274a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Build **performant**, **native** and **cross-platform** desktop applications wit NodeGUI is powered by **Qt5** 💚 which makes it CPU and memory efficient as compared to other chromium based solutions like electron. -If you are looking for React based version, check out: [NodeGUI React Desktop](https://github.com/nodegui/react-desktop). +If you are looking for React based version, check out: [React NodeGUI](https://github.com/nodegui/react-nodegui). Visit: https://nodegui.github.io/nodegui for docs. @@ -18,15 +18,14 @@ Visit: https://nodegui.github.io/nodegui for docs. demo_mac -
kitchendemo_macdemo_win +
kitchendemo_macdemo_win
- **More screenshots?** [See examples](https://github.com/nodegui/nodegui/tree/master/examples/) -[See React based examples](https://github.com/nodegui/react-desktop/tree/master/examples/) +[See React based examples](https://github.com/nodegui/react-nodegui/tree/master/examples/) ## Features @@ -50,7 +49,7 @@ Visit: https://nodegui.github.io/nodegui for docs. ## Getting Started -- Check out [nodegui-starter](https://github.com/nodegui/nodegui-starter) to get up and running with your own React Desktop app! +- Check out [nodegui-starter](https://github.com/nodegui/nodegui-starter) to get up and running with your own React NodeGUI app! - Read through the [docs](https://nodegui.github.io/nodegui) ## Docs for contributing diff --git a/docs/README.md b/docs/README.md index 314456c1e..629750b95 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,11 +1,11 @@ # main doc -> Looking for React Desktop docs? [React Desktop docs](react/README.md) +> Looking for React NodeGUI docs? [React NodeGUI docs](react/README.md) # Guides and Tutorials - [About NodeGui](tutorial/about.md) -- [React Desktop](react/README.md) +- [React NodeGUI](react/README.md) - [Examples](https://github.com/nodegui/nodegui/tree/master/examples) - [FAQ](faq.md) - [Setting up the Development Environment](tutorial/development-environment.md) diff --git a/docs/_coverpage.md b/docs/_coverpage.md index bf264cc3a..a7056247d 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -1,10 +1,10 @@
-

NodeGui / React Desktop

+

NodeGui / React NodeGUI

An open source library for building cross-platform native desktop applications with JavaScript and CSS like styling.

-NodeGui is based on Qt5 and NOT chromium, hence it is memory and cpu efficient. React Desktop is a React renderer for NodeGui. +NodeGui is based on Qt5 and NOT chromium, hence it is memory and cpu efficient. React NodeGui is a React renderer for NodeGui.

demo diff --git a/docs/react/README.md b/docs/react/README.md index 4259a8eac..f53b4a88d 100644 --- a/docs/react/README.md +++ b/docs/react/README.md @@ -1,11 +1,11 @@ -# React Desktop +# React NodeGUI -- [About React Desktop](react/about.md) -- [Examples](https://github.com/nodegui/react-desktop/tree/master/examples) +- [About React NodeGUI](react/about.md) +- [Examples](https://github.com/nodegui/react-nodegui/tree/master/examples) - [Setting up the Development Environment](tutorial/development-environment.md) - [Creating your First App](react/first-app.md) - [Hello World](react/first-app.md#Hello-World) - - [React Desktop Development in a Nutshell](react/first-app.md#react-desktop-development-in-a-nutshell) + - [React NodeGUI Development in a Nutshell](react/first-app.md#react-nodegui-development-in-a-nutshell) - [Running Your App](react/first-app.md#running-your-app) // TODO from here - [Application Architecture](react/application-architecture.md) diff --git a/docs/react/about.md b/docs/react/about.md index 116ce2d71..922a93047 100644 --- a/docs/react/about.md +++ b/docs/react/about.md @@ -1,22 +1,22 @@ -# About React Desktop +# About React NodeGUI -[React Desktop](https://github.com/nodegui/react-desktop) is an open source library for building cross-platform desktop applications with React and CSS like styling. React Desktop is a custom react renderer for [NodeGui](https://github.com/nodegui/nodegui). React Desktop combines the power and flexibility of React with ease of NodeJs and maturity of Qt5. With React desktop you can build native desktop applications which are underneath Qt applications. This means you could in theory use all of Qt's Gui APIs in Javascript. +[React NodeGUI](https://github.com/nodegui/react-nodegui) is an open source library for building cross-platform desktop applications with React and CSS like styling. React NodeGUI is a custom react renderer for [NodeGui](https://github.com/nodegui/nodegui). React NodeGUI combines the power and flexibility of React with ease of NodeJs and maturity of Qt5. With React NodeGUI you can build native desktop applications which are underneath Qt applications. This means you could in theory use all of Qt's Gui APIs in Javascript. -As React Native was an improvement over Cordova based applications in Mobile app development with web technologies, React Desktop aims to achieve the same with respect to Electron and other chromium based cross platform Gui solutions. React Desktop wants to incorporate everything that is good about Electron: The ease of development, freedom of styling, Native APIs, great documentation, etc. At the same time it aims to be memory and CPU efficient. +As React Native was an improvement over Cordova based applications in Mobile app development with web technologies, React NodeGUI aims to achieve the same with respect to Electron and other chromium based cross platform Gui solutions. React NodeGUI wants to incorporate everything that is good about Electron: The ease of development, freedom of styling, Native APIs, great documentation, etc. At the same time it aims to be memory and CPU efficient. -Also, React Desktop (like NodeGui) is built with Typescript which means you get autocomplete and strong typechecking support from the IDE even when used in a Javascript project. +Also, React NodeGUI (like NodeGui) is built with Typescript which means you get autocomplete and strong typechecking support from the IDE even when used in a Javascript project. -Get started building with React Desktop in the [First React Desktop app](react/first-app.md). +Get started building with React NodeGUI in the [First React NodeGUI app](react/first-app.md). ### Updating Dependencies -As soon as a new version of NodeGui is released a corresponding version of React Desktop will be released simultaneously. This makes sure that both NodeGui and React Desktop releases go out in sync. NodeGui an React Desktop will be released as separate packages in order keep everything easily maintainable. +As soon as a new version of NodeGui is released a corresponding version of React NodeGUI will be released simultaneously. This makes sure that both NodeGui and React NodeGUI releases go out in sync. NodeGui an React NodeGUI will be released as separate packages in order keep everything easily maintainable. ### Versioning -NodeGui/React Desktop follows [`semver`](https://semver.org). +NodeGui/React NodeGUI follows [`semver`](https://semver.org). For most applications, and using any recent version of npm, -running `$ npm install @nodegui/react-desktop` will do the right thing. +running `$ npm install @nodegui/react-nodegui` will do the right thing. ## Core Philosophy diff --git a/docs/react/first-app.md b/docs/react/first-app.md index bdf32ce96..17b204be6 100644 --- a/docs/react/first-app.md +++ b/docs/react/first-app.md @@ -1,28 +1,28 @@ -# Writing Your First React Desktop App +# Writing Your First React NodeGUI App -React Desktop enables you to create desktop applications with JavaScript (React). React Desktop is a react renderer for NodeGui. This makes it extrememly memory and CPU efficient as compared to other popular Javascript Desktop GUI solutions. +React NodeGUI enables you to create desktop applications with JavaScript (React). React NodeGUI is a react renderer for NodeGui. This makes it extrememly memory and CPU efficient as compared to other popular Javascript Desktop GUI solutions. ## Hello World Clone and run the code in this tutorial by using the -[`nodegui/react-desktop-starter`][quick-start] repository. +[`nodegui/react-nodegui-starter`][quick-start] repository. **Note**: Running this requires [Git](https://git-scm.com) and [npm](https://www.npmjs.com/). ```sh # Clone the repository -$ git clone https://github.com/nodegui/react-desktop-starter +$ git clone https://github.com/nodegui/react-nodegui-starter # Go into the repository -$ cd react-desktop-starter +$ cd react-nodegui-starter # Install dependencies $ npm install # Run the app $ npm start ``` -As far as development is concerned, an React Desktop application is essentially a +As far as development is concerned, an React NodeGUI application is essentially a Node.js application. The starting point is a `package.json` that is identical -to that of a Node.js module. A most basic React Desktop app would have the following +to that of a Node.js module. A most basic React NodeGUI app would have the following folder structure: ```text @@ -31,21 +31,21 @@ your-app/ ├── index.js ``` -## React Desktop Development in a Nutshell +## React NodeGUI Development in a Nutshell -React Desktop apps are developed in JavaScript using the same principles and methods -found in React Native development. React Desktop exposes native widgets in the form of React components. Also, since we are now not running inside a browser, there is no DOM. Hence browser based APIs are NOT available. But you do have access to complete NodeJs APIs along with some exported Qt Apis.All APIs related to React Desktop are found in `@nodegui/react-desktop` module. Additionally you can also access APIs and features from NodeGui via +React NodeGUI apps are developed in JavaScript using the same principles and methods +found in React Native development. React NodeGUI exposes native widgets in the form of React components. Also, since we are now not running inside a browser, there is no DOM. Hence browser based APIs are NOT available. But you do have access to complete NodeJs APIs along with some exported Qt Apis.All APIs related to React NodeGUI are found in `@nodegui/react-nodegui` module. Additionally you can also access APIs and features from NodeGui via the `@nodegui/nodegui` module. These can be required like any other Node.js module: ```javascript require("@nodegui/nodegui"); -require("@nodegui/react-desktop"); +require("@nodegui/react-nodegui"); ``` A simple `main.js`. ```javascript -import { Renderer, View, Text, Button, Window } from "@nodegui/react-desktop"; +import { Renderer, View, Text, Button, Window } from "@nodegui/react-nodegui"; import React, { useState } from "react"; const App = () => { @@ -98,19 +98,19 @@ directory. ## Trying this Example Clone and run the code in this tutorial by using the -[`nodegui/react-desktop-starter`][quick-start] repository. +[`nodegui/react-nodegui-starter`][quick-start] repository. **Note**: Running this requires [Git](https://git-scm.com) and [npm](https://www.npmjs.com/). ```sh # Clone the repository -$ git clone https://github.com/nodegui/react-desktop-starter +$ git clone https://github.com/nodegui/react-nodegui-starter # Go into the repository -$ cd react-desktop-starter +$ cd react-nodegui-starter # Install dependencies $ npm install # Run the app $ npm start ``` -[quick-start]: https://github.com/nodegui/react-desktop-starter +[quick-start]: https://github.com/nodegui/react-nodegui-starter