Skip to content

Commit 2546bbb

Browse files
authored
Merge pull request #142 from ml5js/featuresAndMore
New Features, some fixes and more
2 parents 0087df9 + 6964aa4 commit 2546bbb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+4426
-7895
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ If you want to help develop this library, here are the steps to get started with
88

99
1. Fork the repository to your account, and then clone it your computer:
1010
```bash
11-
git clone https://github.com/YOURGITHUBHANDLE/ML5.git
11+
git clone https://github.com/YOURGITHUBHANDLE/ml5-library.git
1212
```
1313

1414
2. Install dependencies:
1515

1616
```bash
17-
cd ML5
17+
cd ml5-library
1818
npm install
1919
```
2020

2121
3. This project is developed using [webpack](https://webpack.js.org/). Webpack is a module bundler that allows to "bundle" different files into one file. This allows you to write files for specific things and then mix them all together into one single file that you can import in your page.
2222

23-
Under the `/src` folder you will see that there are sub-folders for all ML5 methods. You can edit each file individually and then `build` everything into one single library.
23+
Under the `/src` folder you will see that there are sub-folders for all ml5 methods. You can edit each file individually and then `build` everything into one single library.
2424

2525
Before `building` the library you can see if everything is working.
2626

@@ -89,7 +89,7 @@ Create a new folder called `/experiments` in the project's root folder. Create a
8989

9090
```javascript
9191
'use strict';
92-
console.log('ML5 loaded');
92+
console.log('ml5 loaded');
9393
```
9494

9595
To something like this:
@@ -139,46 +139,7 @@ Create a new folder called `/experiments` in the project's root folder. Create a
139139
140140
## Running Unit Tests
141141
142-
143-
144-
## ML5 Website
145-
146-
The [ML5 website](https://ml5js.org/) is built with [Docusaurus](https://docusaurus.io/).
147-
148-
Docusaurus is an open-source library, built with React, to create and maintain documentation websites.
149-
150-
All the website content and documentation lives in the master branch but website is served from `gh-pages`.
151-
152-
### Contributing
153-
154-
Almost all the content for the website can be found in markdown under the `docs/` folder at the root level of the repository.
155-
The naming convention we are using is the following:
156-
157-
* Examples are named: `examples-[name of example].md`
158-
* API Reference files are named: `api-[Class].md`
159-
* Glossary: `glossary-[type].md`
160-
161-
If you wish to help develop the website, first you'll need to install the necessary dependencies for Docusaurus.
162-
163-
From the root of the project run:
164-
```
165-
cd website
166-
npm install
167-
```
168-
169-
And then start the development server:
170-
171-
```
172-
npm run start
173-
```
174-
175-
This wil create a server that will reload whenever there are changes in the website source code.
176-
177-
To build the website run:
178-
179-
```bash
180-
npm run build
181-
```
142+
WIP
182143
183144
## Additional Resources
184145

0 commit comments

Comments
 (0)