docs: add basic usage to README #980

TinsFox · 2023-11-15T12:48:13Z

Update docs

Description

As a new user, I prefer to see how it was done in the beginning rather than upgrading the documentation. This can feel strange to new users

ayushmanchhabra · 2023-11-15T15:57:06Z

I recently moved all documentation from README to JSDoc comments so that it can be autogenerated as a website. I don't really see an issue with not having install instructions on the README if a link to a docs site is given.

sysrage

I do agree basic usage instructions should be included in the README. The documentation can/should be used more as an API reference if/when basic usage isn't enough.

README.md

ayushmanchhabra · 2023-11-15T16:20:15Z

What do you mean by basic usage? I'm guess I'm too familiar with the options so everything to me seems like basic usage to me :P

sysrage · 2023-11-15T16:23:43Z

What do you mean by basic usage? I'm guess I'm too familiar with the options so everything to me seems like basic usage to me :P

Essentially what's being added in this PR.

TinsFox · 2023-11-16T02:49:50Z

What do you mean by basic usage? I'm guess I'm too familiar with the options so everything to me seems like basic usage to me :P

It's how to use the library quickly to get him to do something that's expected. Just the most basic configuration is fine, probably the effect of a command like 'nwbuild --mode=build', if this command automatically fills in the other default parameters

TinsFox · 2023-11-16T02:58:14Z

I recently moved all documentation from README to JSDoc comments so that it can be autogenerated as a website. I don't really see an issue with not having install instructions on the README if a link to a docs site is given.

I see that, but I recommend removing this line

nw-builder/.gitignore

Line 11 in 3e367f3

doc/*.md

because keeping the Markdown file allows us to add some extra instructions to it, rather than completely handing it over to the program

ayushmanchhabra · 2023-11-17T16:19:28Z

I recently moved all documentation from README to JSDoc comments so that it can be autogenerated as a website. I don't really see an issue with not having install instructions on the README if a link to a docs site is given.

I see that, but I recommend removing this line

nw-builder/.gitignore

Line 11 in 3e367f3

doc/*.md

because keeping the Markdown file allows us to add some extra instructions to it, rather than completely handing it over to the program

I understand what you mean. This is how I initially managed the docs. I'm trying to automate as many things as I can so that the maintainer(s) after me will have it easier. Right now docs gen is far from what I want it to be but working on making it better.

ayushmanchhabra · 2023-11-24T15:19:19Z

@TinsFox I've made a couple of commit suggestions

TinsFox · 2023-11-26T09:17:59Z

@TinsFox I've made a couple of commit suggestions

I can't see your comment. Did you forget to submit it?

ayushmanchhabra · 2023-11-26T14:40:23Z

Ah I think you merged main into the branch which is why the commit suggestions got hidden

ayushmanchhabra

I'm fine with the changes here. I have to figure out how to setup docs nicely which I'll do in subsequent PRs.

README.md

ayushmanchhabra · 2023-11-17T16:25:06Z

README.md

+With npm:
+
+```shell
+npm install nw-builder -D


Suggested change

npm install nw-builder -D

npm install -D nw-builder

ayushmanchhabra · 2023-11-17T16:25:31Z

README.md

+With yarn:
+
+```shell
+yarn add nw-builder -D


Suggested change

yarn add nw-builder -D

yarn add -D nw-builder

ayushmanchhabra · 2023-11-17T16:26:34Z

README.md

+With pnpm:
+
+```shell
+pnpm add nw-builder -D


Suggested change

pnpm add nw-builder -D

pnpm add -D nw-builder

ayushmanchhabra · 2023-11-17T16:34:46Z

README.md

+Here is two way to use nw-build to build your nwjs applications
+
+### CLI
+
+1. To get nwjs cache
+    ```bash
+    nwbuild --mode=get
+    ```
+2. To run nwjs application
+    ```bash
+    nwbuild --mode=run
+    ```
+3. To build nwjs application
+    ```bash
+    nwbuild --mode=build
+    ```


Suggested change

Here is two way to use nw-build to build your nwjs applications

### CLI

1. To get nwjs cache

```bash

nwbuild --mode=get

```

2. To run nwjs application

```bash

nwbuild --mode=run

```

3. To build nwjs application

```bash

nwbuild --mode=build

```

Here are two ways to use nw-builder:

### CLI

1. To get and cache NW.js:

```shell

nwbuild --mode=get

```

2. To run your NW.js application

```shell

nwbuild --mode=run

```

3. To build your NW.js application

```shell

nwbuild --mode=build

```

ayushmanchhabra · 2023-11-17T16:42:37Z

README.md

+2. Create a build script
+    ```javascript
+    // scripts/build.js
+    const { nwbuild } = require("nw-builder");


Suggested change

const { nwbuild } = require("nw-builder");

import { nwbuild } from "nw-builder";

Direct CJS import does not work. You need to import it via the import("nwbuild") function call.

ayushmanchhabra · 2023-11-17T16:54:52Z

README.md

+      version: "latest",
+      flavor: "normal",
+      platform: "linux",
+      arch: "x64",
+      outDir: "./build",
+      cache: false,
+      app: { ... },


Suggested change

version: "latest",

flavor: "normal",

platform: "linux",

arch: "x64",

outDir: "./build",

cache: false,

app: { ... },

Could we remove these options to match the CLI usage?

Refs: #980 ## Description of Changes Move useful usage docs from JSDoc code comments to `README.md`.

docs: update docs

8e43168

TinsFox requested a review from ayushmanchhabra as a code owner November 15, 2023 12:48

sysrage requested changes Nov 15, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

TinsFox and others added 4 commits November 16, 2023 10:32

docs: fix run mode

08f19fe

docs: rm migration guide

05a28d1

docs: add Installation and usage section

6a31e3e

Merge branch 'main' into main

e7d86ef

ayushmanchhabra changed the title ~~docs: update docs~~ docs: add basic usage to README Nov 17, 2023

Merge branch 'main' into main

67f50d6

ayushmanchhabra approved these changes Nov 26, 2023

View reviewed changes

ayushmanchhabra merged commit 968eae9 into nwutils:main Nov 26, 2023

ayushmanchhabra mentioned this pull request Dec 26, 2023

docs: update docs #1004

Merged

ayushmanchhabra mentioned this pull request Jan 22, 2024

chore(docs): move docs to README.md #1013

Merged

ayushmanchhabra added a commit that referenced this pull request Jan 22, 2024

chore(docs): move docs to README.md (#1013)

0119cb8

Refs: #980 ## Description of Changes Move useful usage docs from JSDoc code comments to `README.md`.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add basic usage to README #980

docs: add basic usage to README #980

TinsFox commented Nov 15, 2023

ayushmanchhabra commented Nov 15, 2023

sysrage left a comment •

edited

Loading

ayushmanchhabra commented Nov 15, 2023

sysrage commented Nov 15, 2023

TinsFox commented Nov 16, 2023

TinsFox commented Nov 16, 2023

ayushmanchhabra commented Nov 17, 2023 •

edited

Loading

ayushmanchhabra commented Nov 24, 2023

TinsFox commented Nov 26, 2023

ayushmanchhabra commented Nov 26, 2023

ayushmanchhabra left a comment

ayushmanchhabra Nov 17, 2023

ayushmanchhabra Nov 17, 2023

ayushmanchhabra Nov 17, 2023

ayushmanchhabra Nov 17, 2023

ayushmanchhabra Nov 17, 2023

ayushmanchhabra Nov 17, 2023

ayushmanchhabra Nov 17, 2023

ayushmanchhabra Nov 17, 2023

	const { nwbuild } = require("nw-builder");
	import { nwbuild } from "nw-builder";

docs: add basic usage to README #980

docs: add basic usage to README #980

Conversation

TinsFox commented Nov 15, 2023

Update docs

Description

ayushmanchhabra commented Nov 15, 2023

sysrage left a comment • edited Loading

Choose a reason for hiding this comment

ayushmanchhabra commented Nov 15, 2023

sysrage commented Nov 15, 2023

TinsFox commented Nov 16, 2023

TinsFox commented Nov 16, 2023

ayushmanchhabra commented Nov 17, 2023 • edited Loading

ayushmanchhabra commented Nov 24, 2023

TinsFox commented Nov 26, 2023

ayushmanchhabra commented Nov 26, 2023

ayushmanchhabra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sysrage left a comment •

edited

Loading

ayushmanchhabra commented Nov 17, 2023 •

edited

Loading