terminal doc stubs

This commit is contained in:
David Mark Clements
2023-12-15 13:57:30 +01:00
parent a9cc6e6b3d
commit 8f5eddbaba
5 changed files with 41 additions and 4 deletions

View File

@@ -1,4 +1,4 @@
# Making a Pear Application
# Making a Pear Desktop Application
## Step 1. Install modules

View File

@@ -0,0 +1,17 @@
# Making a Pear Terminal Application
## Step 1. Install modules
This app uses these modules: `hyperswarm`, `hypercore-crypto`, and `b4a`.
```
$ npm i hyperswarm hypercore-crypto b4a
```
**Note**: If the modules are installed while the app is running an error is thrown similar to `Cannot find package 'hyperswarm' imported from /app.js`. When installing modules, close down the app, before they can be installed.
- [hyperswarm](https://www.npmjs.com/package/hyperswarm). One of the main building blocks. Find peers that share a "topic".
- [hypercore-crypto](https://www.npmjs.com/package/hypercore-crypto). A set of crypto function used in Pear.
- [b4a](https://www.npmjs.com/package/b4a). A set of functions for bridging the gap between the Node.js `Buffer` class and the `Uint8Array` class.
## Step 2.

View File

@@ -0,0 +1,18 @@
# Starting a Pear Terminal Project
## Step 1. Init
First create a new project using `pear init`.
```
$ mkdir chat-bot
$ cd chat-bot
$ pear init --yes
```
This will create a base structure for the project.
- `package.json`. Configuration for the app. Notice the `pear` property.
- `index.js`. The entrpoint for the app.
- `app.js`. The main code.
- `test/index.test.js`. Skeleton for writing tests.