-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
27 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,28 @@ | ||
# ml5-archive-docs | ||
ml5 docs archive | ||
|
||
## Repo Description | ||
This Repository is to archive the reference documents for the old version of ml5.js website. | ||
|
||
## Purpose | ||
The purpose of this archive is to maintain historical documentation for previous versions of ml5.js. This ensures that users working with older versions of the library can still access relevant documentation and examples. | ||
|
||
## Contents | ||
This repository includes: | ||
- API documentation for deprecated versions | ||
- Tutorials and guides for older ml5.js features | ||
- Code examples demonstrating usage of previous ml5.js versions | ||
|
||
## How to Use | ||
- Remotly | ||
- Visit [this page](https://ml5js.github.io/ml5-archive-docs/) | ||
- Locally | ||
- Clone this repo | ||
- Use live preview or any plugin that can run as local server to host `docs/index.html` | ||
- visit the local site | ||
|
||
## Contributing | ||
While this is an archive, we welcome contributions that improve the clarity or accuracy of the documentation. Please submit a pull request if you have any suggestions or corrections. | ||
|
||
## Related Resources | ||
- [Current ml5.js Documentation](https://ml5js.org/) | ||
- [ml5.js GitHub Repository](https://github.com/ml5js/ml5-library) |