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

Commit 9f50643

Browse files
committed
README.md
1 parent 71bf920 commit 9f50643

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ node -v
7373
```
7474
Check the latest version of NVM before you install (it might be higher than v0.35.3). You can go online to learn how to use NVM to switch node versions on the fly.
7575

76-
##### Using sudo
77-
It is important to note that because our scripts use the Bluetooth libraries of the OS, it is required to use sudo (or you will get a warning and the scripts won't work). You need to decide if you are ok to use sudo or not.
76+
##### Using sudo - a Warning
77+
It is important to note that because our scripts use OS level Bluetooth libraries, it may be required to use sudo (or you will get a warning and the scripts won't work). You need to decide if you are ok to use sudo or not.
7878

7979
You also need to check that the version of node you are using is as expected for sudo:
8080
```
@@ -83,7 +83,7 @@ v0.10.23
8383
$ sudo node -v
8484
v0.11.8-pre
8585
```
86-
As you can see here, the sudo node version is not the same as the current user version. Here's a [workaround](https://stackoverflow.com/questions/21215059/cant-use-nvm-from-root-or-sudo).
86+
As you can see here, the sudo node version is not the same as the current user version. Here's a [workaround](https://stackoverflow.com/questions/21215059/cant-use-nvm-from-root-or-sudo). You can google-fu more about this topic.
8787

8888
### Installation
8989

@@ -92,16 +92,16 @@ You have two options for installation:
9292
#### 1. Use NPM
9393
The Mbient JavaScript SDK relies on [Noble](https://github.com/mbientlab/noble) and [Noble-Device](https://github.com/mbientlab/noble-device) for Bluetooth Low Energy communications.
9494

95-
You need to setup the relevant [prerequisites for Noble](https://github.com/mbientlab/noble#prerequisites) and then [install Noble](https://github.com/mbientlab/noble#install).
96-
97-
Make sure you use our versions of these libraries as the original packages have been abandoned.
95+
You need to setup the relevant [prerequisites for Noble](https://github.com/mbientlab/noble#prerequisites) and then [install Noble](https://github.com/mbientlab/noble#install). Make sure you use our versions of these libraries as the original packages have been abandoned.
9896

9997
Then you can simply install the MetaWear package lib with NPM using the command line:
100-
```javascript
98+
```
10199
npm install metawear
102-
npm update metawear
103100
```
104101
This step takes a long time as all the packages are installed and the MetaWear CPP library will be compiled on your machine. You may or may not need to update.
102+
```
103+
npm update metawear
104+
```
105105

106106
#### 2. Use our Repository
107107
We packaged everything for you already in this repository with the package.json file ready to be installed with npm.
@@ -132,11 +132,13 @@ Please note that the examples in our examples folder will use the local metawear
132132
```javascript
133133
var MetaWear = require('../index')
134134
```
135+
This would be using the local metawear code. You will probably never need this unless you are planning to change our internal libraries.
135136

136137
Simply change it to this:
137138
```javascript
138139
var MetaWear = require('metawear');
139140
```
141+
This would be using the metawear code in your local npm `node_modules` directory as installed. This is the prefered way.
140142

141143
#### Notes
142144
You should familiarize yourself with this README and our tutorials since there a few limitiations and other gotchas spelled out, such as the maximum number of simultaneous Bluetooth connections.

0 commit comments

Comments
 (0)