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.

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

Synchronous Request and Simple Visualization Tutorial #179

Merged
merged 10 commits into from
Oct 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
examples/3D_engine/legacy/three_r*.js
examples/3D_engine/three_r*.js
examples/3D_engine/OrbitControls.js
examples/3D_engine/OrbitControls.js
*.min.js
3 changes: 2 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
*.js
*.html
.examples/**html
*.min.js
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# vesseljs

<!-- ![NPM Package](https://www.npmjs.com/package/@shiplab/vessels) -->

[![NPM Package][npm]][npm-url]
[![Contributors][contributors]][contributors-url]
![Vessel.js CI](https://github.com/shiplab/vesseljs/actions/workflows/ci.yml/badge.svg)

<!-- [![Build Size][build-size]][build-size-url] -->
<!-- [![NPM Downloads][npm-downloads]][npmtrends-url] -->

**Vessel.js** is a JavaScript library for conceptual ship design with an object-oriented paradigm. Vessel.js represents the vessel as an object, which is used to simulate different functionalities and behaviors. Currently, the library includes methods for hydrostatic and stability calculations.

The library is developed by **Ship Design and Operation Lab** at Norwegian University of Science and Technology (**NTNU**) in Ålesund. For documentation and other resources, visit our [wiki](https://github.com/shiplab/vesseljs/wiki).
Expand All @@ -11,3 +18,8 @@ The library is developed by **Ship Design and Operation Lab** at Norwegian Unive
When contributing, fork the repository and send pull requests with your commits. If your modifications are only to files related to examples and you have pull request authorization, you can approve them by yourself. If not, then wait for review and approval by the development team.

You are also welcome to create [issues](https://github.com/shiplab/vesseljs/issues) reporting bugs or suggesting improvements and features for development.

[npm]: https://img.shields.io/npm/v/@shiplab/vessels
[npm-url]: https://www.npmjs.com/package/@shiplab/vessels
[contributors]: https://img.shields.io/github/contributors/shiplab/vesseljs
[contributors-url]: https://github.com/badges/shields/shiplab/vesseljs
Loading