Skip to content

Commit 7d23451

Browse files
committed
Move Process section from CONTRIBUTING.md to README.md
1 parent 984e746 commit 7d23451

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,19 @@ npx prettier --write path/to/file
4646
```
4747

4848
For more options with the command line, refer to the [Prettier Documentation](https://prettier.io/docs/en/cli.html)
49+
50+
## Process
51+
52+
_This section explains how this repository was creates and is for reference purposes only. The steps outlines in this section do not need to be followed by contributors._
53+
54+
I am building the library using Webpack, which was installed with:
55+
56+
```
57+
npm install --save-dev webpack webpack cli
58+
```
59+
60+
I also created package.json using `npm init` and set up a basic config file for a library build named `webpack.config.js`. I configured package.json so I could run webpack with `npm run build`.
61+
62+
From the original ml5 library's `src` folder, I copied over all source files from the `NeuralNetwork` directory and necessary dependency files from `utils` directory. I also copied over `index.js` from the `src` folder and deleted everything unrelated to NeuralNetwork. I then installed `@tensorflow/[email protected]`, `@tensorflow/[email protected]`, and `[email protected]` with npm.
63+
64+
At this point, the library can be built without error. I was only getting an error about exceeding recommended size limit. For the build, I am using the latest version of node, npm, and tfjs. I have not tested all the features of NeuralNetwork, but it appears to be working just fine.

README.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,3 @@ npm run build
2222
This will create the build in the dist folder.
2323

2424
Open `examples/NeuralNetwork/index.html` in the browser to see the build running an example from the ml5 website.
25-
26-
## Process
27-
28-
_This section explains how this repository was creates and is for reference purposes only. The steps outlines in this section do not need to be followed by contributors._
29-
30-
I am building the library using Webpack, which was installed with:
31-
32-
```
33-
npm install --save-dev webpack webpack cli
34-
```
35-
36-
I also created package.json using `npm init` and set up a basic config file for a library build named `webpack.config.js`. I configured package.json so I could run webpack with `npm run build`.
37-
38-
From the original ml5 library's `src` folder, I copied over all source files from the `NeuralNetwork` directory and necessary dependency files from `utils` directory. I also copied over `index.js` from the `src` folder and deleted everything unrelated to NeuralNetwork. I then installed `@tensorflow/[email protected]`, `@tensorflow/[email protected]`, and `[email protected]` with npm.
39-
40-
At this point, the library can be built without error. I was only getting an error about exceeding recommended size limit. For the build, I am using the latest version of node, npm, and tfjs. I have not tested all the features of NeuralNetwork, but it appears to be working just fine.

0 commit comments

Comments
 (0)