Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(verb): small documentation changes #67

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

docs(verb): small documentation changes #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
198a00f
docs(verb): small documentation changes
z3dev Oct 1, 2024
4aa6726
docs(verb): changes as requested
z3dev Oct 1, 2024
b6e9513
docs(verb): added information on how to import the JS package
z3dev Oct 20, 2024
9dda11e
docs(verb): adjusted badges in README
z3dev Oct 27, 2024
47cbee6
docs(verb): another try
z3dev Oct 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
[![Build Status](https://travis-ci.org/pboyer/verb.svg?branch=master)](https://travis-ci.org/pboyer/verb)

# verb

[![NPM version](https://badge.fury.io/js/verb-nurbs.svg)](https://badge.fury.io/js/verb-nurbs)
[![NPM downloads](https://img.shields.io/npm/dw/verb-nurbs)](https://www.npmjs.com/package/verb-nurbs)
[![Stability](https://img.shields.io/badge/stability-stable-success)](https://github.com/emersion/stability-badges#stable)
[![License](https://img.shields.io/github/license/pboyer/verb)](https://github.com/pboyer/verb/blob/master/LICENSE)

### Open-source, cross-platform NURBS

<strong>verb</strong> is a library for creating and manipulating NURBS surfaces and curves in many languages including JavaScript.
Expand Down Expand Up @@ -30,6 +33,11 @@ You can install verb with

Pre-compiled JavaScript can be found in [build/js](https://github.com/pboyer/verb/blob/master/build/js).

In addition, this package is hosted at UNPKG, and can be imported directly into webpages.
```
<script language="javascript" src="https://unpkg.com/verb-nurbs"></script>
```

### Examples

You'll find many usage examples in the [examples directory](https://github.com/pboyer/verb/blob/master/examples) and amongst the [tests](https://github.com/pboyer/verb/tree/master/test).
Expand Down
8 changes: 6 additions & 2 deletions docs/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ You can install verb with npm

npm install verb-nurbs

You can use verb with require.js (AMD) or browserify (commonjs) in the browser or in node.js.
And immediately use the pre-compiled JavaScript packages found in [build/js](https://github.com/pboyer/verb/blob/master/build/js).

Pre-compiled JavaScript can be found in [build/js](https://github.com/pboyer/verb/blob/master/build/js).
You can use verb with require.js (AMD) or browserify (commonjs) in the browser or in node.js.

You'll find many usage examples in the [examples directory](https://github.com/pboyer/verb/blob/master/examples).

Expand All @@ -69,6 +69,10 @@ Compile to javascript:

npm run build

Create both ES and UMD versions of the verb package:

npm run package

Run all unit tests:

npm run test
Expand Down
2 changes: 1 addition & 1 deletion src/verb/core/Vec.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ using Lambda;

import verb.core.Data;

// Tools for working with matrices
// Tools for working with vectors

@:expose("core.Vec")
class Vec {
Expand Down
2 changes: 2 additions & 0 deletions src/verb/geom/NurbsCurve.hx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ class NurbsCurve extends SerializableBase implements ICurve {
//Construct a NurbsCurve by interpolating a collection of points. The resultant curve
//will pass through all of the points.
//
//Note: The points are not verified, and may produce a curve with invalid control points. For example, consecutive duplicate points.
//
//**params**
//
//* An array of points
Expand Down