Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Commit 842c050

Browse files
committed
Revise grammar of the previous commit
- Improve capitalization in `install.md` - Revise `try_sample_bundle.md` to a more formal written English Tim Signed-off-by: Tim_Tech_Dev <[email protected]>
1 parent b15b6b2 commit 842c050

File tree

2 files changed

+24
-25
lines changed

2 files changed

+24
-25
lines changed

docs/getting_started/install.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ In order to download necessary tools and to install nodecg-io using the CLI you
99
You'll need the following tools:
1010

1111
- [Git](https://git-scm.com)
12-
- [Node.JS](https://nodejs.org/en/) v12.0.0 or newer
13-
- [Npm](https://www.npmjs.com/get-npm) 7.0.0 or newer
12+
- [Node.js](https://nodejs.org/en/) v12.0.0 or newer
13+
- [npm](https://www.npmjs.com/get-npm) 7.0.0 or newer
1414
- [NodeCG](https://nodecg.dev/) 1.4.0 or newer (1.7.0 or higher recommended)
1515

1616
### Native Build Tools
@@ -60,7 +60,7 @@ _Note:_ If you are running on Linux, you may need to use `sudo` if your npm inst
6060

6161
## Install nodecg-io using the nodecg-io CLI
6262

63-
With the nodecg-io CLI installed you can run this command inside a nodecg installation to install nodecg-io:
63+
With the nodecg-io CLI installed you can run this command inside a NodeCG installation to install nodecg-io:
6464

6565
```shell
6666
nodecg-io install
@@ -83,7 +83,8 @@ If you want to every change your nodecg-io installation to add/remove a service
8383
When starting NodeCG you should see that all nodecg-io related bundles should be loaded and that you can now access nodecg-io in your NodeCG dashboard.
8484

8585
There are many example bundles premade for most services, so you may take a
86-
look at the [“Try an included sample”](../getting_started/try_example_bundle.md)-Guide.
86+
look at the [“Try an included sample”](../getting_started/try_example_bundle.md)-Guide (It
87+
will also tell you how to log in and how to use the GUI).
8788
Or you could directly take a deep dive into our framework and either [create a new bundle](./create_new_bundle.md)
8889
or [integrate an existing bundle](./existing_bundle.md). There are other bundles
8990
using nodecg-io, witch you could try, so may take a look around GitHub or GitLab.
@@ -96,4 +97,4 @@ If you want to uninstall nodecg-io you can run the following command:
9697
nodecg-io uninstall
9798
```
9899

99-
This will remove the `nodecg-io` directory inside your nodecg installation and also will remove it from the loaded bundle paths in your nodecg configuration.
100+
This will remove the `nodecg-io` directory inside your NodeCG installation and also will remove it from the loaded bundle paths in your NodeCG configuration.

docs/getting_started/try_example_bundle.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
# Try an included sample
22

3-
Trying one of the premade example bundles, is a good way to get to know the
3+
Trying one of the premade example bundles is a good way to get to know the
44
framework and especially the selected service.
55

66
## Step 1: Installing the Sample
77

88
If you installed **dev** branch or cloned nodecg-io directly from GitHub all the
99
samples should be already installed (you can move to step 2). In case you
1010
installed the **production** branch of nodecg-io, you may have to download the
11-
sample before you can use it. In case you already installed it previously you
12-
can move on to step 2.
13-
Installing and uninstalling of sample bundles can be done with the nodecg-io
14-
CLI.
11+
sample before you can use it. Installing and uninstalling of sample bundles can be done with the nodecg-io
12+
CLI. This can be done as follows.
1513

1614
Run this command inside your NodeCG folder:
1715

@@ -24,14 +22,14 @@ You will be presented with a pair of options:
2422

2523
<!-- prettier-ignore-start -->
2624

27-
1. You can select the version of nodecg-io to install. **Select here the version already installed.** (Since this is not the migration guide)
25+
1. You can select the version of nodecg-io to install. **Select the version that is already installed here.** (Since this is not the migration guide)
2826
<pre><b><span style="color:#1cdc9a">user@computer</span>:<span style="color:#3daee9">~/nodecg</span></b>$ nodecg-io install
2927
Installing nodecg-io...
3028
Detected nodecg installation at /home/user/nodecg.
3129
<span style="color:#11d116">?</span> <b>Which version do you want to install?</b> (Use arrow keys)
3230
development
3331
<span style="color:#1abc9c">❯ 0.1</span></pre>
34-
2. You can select the sample bundles to be included. **Select here the sample(s) you want to try.**
32+
2. You can select the sample bundles to be included. **Select the sample(s) you want to try here.**
3533
<pre><b><span style="color:#1cdc9a">user@computer</span>:<span style="color:#3daee9">~/nodecg</span></b>$ nodecg-io install
3634
Installing nodecg-io...
3735
Detected nodecg installation at /home/user/nodecg.
@@ -61,7 +59,7 @@ the `Run and Debug` Explorer View:
6159

6260
### Using the terminal
6361

64-
You also launch NodeCG using your terminal with:
62+
You may also launch NodeCG using your terminal with:
6563

6664
<pre><b><span style="color:#1cdc9a">user@computer</span>:<spanstyle="color:#3daee9">~/nodecg</span></b>$ npm run start
6765

@@ -75,7 +73,7 @@ info: [nodecg-io-core] Minzig!
7573

7674
info: [nodecg/lib/server] NodeCG running on http://localhost:9090</pre>
7775

78-
Now you can open the NodeCG dashboard under <http://localhost:9090>.
76+
Now you can open the NodeCG dashboard (by default) under <http://localhost:9090>.
7977

8078
## Step 3: Log in to nodecg-io
8179

@@ -87,23 +85,23 @@ If you are logging in for the first time you will have to set your password.
8785

8886
Else you simply have to log in with your previously chosen password.
8987

90-
Now you are in the `nodecg-io` config menu. It should look like this:
88+
Now you are looking at the `nodecg-io` config menu. It should look like this:
9189

9290
![`nodcg-io` config menu](../assets/nodcg-io-dashboard.png)
9391

9492
## Step 4: Learning how to use the GUI
9593

96-
The current GUI is just intended to make the project usable, but is not very
94+
The current GUI is just intended to make the project usable, but it is not very
9795
user-friendly. As a more long term solution, a new GUI will be developed that
98-
also focuses at user experience. But till the new GUI is developed you will have
96+
also focuses on user experience. Until the new GUI is developed, you will have
9997
to arrange yourself with this one. So, to get started:
10098

10199
![`nodcg-io` colour coded](../assets/nodcg-io-colored.png)
102100

103101
### In <span style="color:#b06770">pink</span>: NodeCG Tabs
104102

105-
Here you will find every NodeCG-bundle, which has a dashboard. Here you may
106-
select the [`nodecg-io-debug`](../samples/debug.md)-dashboard, if you have it
103+
Here you will find every NodeCG-bundle that has a dashboard. Here you may
104+
select the [`nodecg-io-debug`](../samples/debug.md)-dashboard, if it is
107105
installed.
108106

109107
### In <span style="color:#b6b61c">yellow</span>: Monaco editor
@@ -121,7 +119,7 @@ _Creating a new service instance_:
121119

122120
This can be accomplished by selecting the item `'New'`. Then a new dropdown will
123121
be revealed, in witch you may select the service type. Additionally, you must
124-
select an instance name. Then click `'Create'`. The new created instance should
122+
select an instance name. Then click `'Create'`. The newly created instance should
125123
be selected.
126124

127125
_Configure a service instance_:
@@ -136,23 +134,23 @@ This can be accomplished by selecting an existing instance. Then click
136134

137135
### In <span style="color:#69318e">violet</span>: Bundles section
138136

139-
This section has tree dropdowns:
137+
This section has three dropdowns:
140138

141139
1. Bundle: Here you can select a bundle to configure.
142-
2. Service: If this bundle uses more than one service, you can select her the
143-
service to set or unset.
140+
2. Service: If this bundle uses more than one service, you may select the
141+
service to set or unset here.
144142
3. Service Instance: Here you can select one instance of the service type set at
145143
2 or `none`.
146144

147145
### In <span style="color:#b71424">red</span>: Unset all Button
148146

149147
This button will set the service instance for every bundle/service combination
150148
to none, effectively removing the access to every service from all bundles.
151-
**Caution**: This cant be undone, and you will have to set up all the bundles
149+
**Caution**: This can not be undone, and you will have to set up all the bundles
152150
again. _The service instances will be unaffected._
153151

154152
## Step 5: Configure the sample
155153

156-
The configuration for every sample bundle is too different to be included here,
154+
The configurations for every sample bundle differ too greatly from each other to be included here,
157155
so you have to take a look at the documentation for your sample bundle. You will
158156
find it on the left-hand side of this page in the category `Services`.

0 commit comments

Comments
 (0)