瀏覽代碼

Update website

customisations
alemart 2 年之前
父節點
當前提交
2e7f8b429d
共有 9 個檔案被更改,包括 75 行新增86 行删除
  1. 28
    16
      README.md
  2. 0
    7
      docs/contact.md
  3. 2
    2
      docs/demo/instructions.md
  4. 4
    10
      docs/download.md
  5. 1
    21
      docs/faq.md
  6. 2
    2
      docs/getting-started/create-the-augmented-scene.md
  7. 26
    10
      docs/getting-started/index.md
  8. 6
    6
      docs/support-my-work.md
  9. 6
    12
      mkdocs.yml

+ 28
- 16
README.md 查看文件

4
 
4
 
5
 Create amazing Augmented Reality experiences with **MARTINS.js**, a GPU-accelerated Augmented Reality engine for the web. Users don't need specialized hardware nor dedicated software - only a modern and compatible web browser.
5
 Create amazing Augmented Reality experiences with **MARTINS.js**, a GPU-accelerated Augmented Reality engine for the web. Users don't need specialized hardware nor dedicated software - only a modern and compatible web browser.
6
 
6
 
7
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J41O00K)
7
+[**Try a demo**](#try-webar-right-now) | [**:heart: Support my work!**](https://alemart.github.io/martins-js/support-my-work)
8
 
8
 
9
-MARTINS.js is developed independently by [Alexandre Martins](https://github.com/alemart) and is [dual-licensed](https://alemart.github.io/martins-js/faq#what-about-the-licensing). It's based on [Speedy Vision](https://github.com/alemart/speedy-vision).
9
+:man_technologist: MARTINS.js is developed by [Alexandre Martins](https://github.com/alemart) and is based on [Speedy Vision](https://github.com/alemart/speedy-vision).
10
 
10
 
11
-## Features
12
-
13
-Currently supported features:
11
+:books: Full documentation is available at <https://alemart.github.io/martins-js/>.
14
 
12
 
15
-* **Image tracking**, also known as natural feature tracking. Use it to track detailed images such as: book covers, cartoons and photos.
13
+:mailbox: [Contact me](https://github.com/alemart) for freelance work if you're not a developer.
16
 
14
 
17
-![WebAR demo](docs/img/demo-aframe.gif) ![WebAR demo](docs/img/demo-hello.gif)
15
+## What can you do with Web-based Augmented Reality?
18
 
16
 
19
-## Documentation
17
+Lots of exciting things that run in the web browser!
20
 
18
 
21
-Full documentation is available at <https://alemart.github.io/martins-js/>.
19
+* Marketing gimmicks
20
+* WebAR Games
21
+* Interactive art
22
+* Tech demos
23
+* ...and more!
22
 
24
 
23
-Cool demos are available at <https://alemart.github.io/martins-js/demos/>.
25
+[Try a demo!](#try-webar-right-now)
24
 
26
 
25
 ## Why use MARTINS.js?
27
 ## Why use MARTINS.js?
26
 
28
 
29
 * **No need to download apps!** MARTINS.js is a WebAR engine. It runs in web browsers. Users can access the AR experience immediately.
31
 * **No need to download apps!** MARTINS.js is a WebAR engine. It runs in web browsers. Users can access the AR experience immediately.
30
 * **Fast and powerful!** MARTINS.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
32
 * **Fast and powerful!** MARTINS.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
31
 * **No need of custom hardware or software!** MARTINS.js is built from scratch using standard web technologies. All it requires is a modern and compatible web browser.
33
 * **No need of custom hardware or software!** MARTINS.js is built from scratch using standard web technologies. All it requires is a modern and compatible web browser.
32
-* **Fully standalone!** MARTINS.js has in it everything it needs to analyze the environment and help you create AR. There are no additional requirements. It's not WebXR.
34
+* **Fully standalone!** MARTINS.js has in it everything it needs to analyze the environment and help you create AR. There are no additional requirements. No need of WebXR.
33
 * **Easy to get started!** MARTINS.js can be used with a `<script>` tag in your page. A static HTML page is enough to get started.
35
 * **Easy to get started!** MARTINS.js can be used with a `<script>` tag in your page. A static HTML page is enough to get started.
34
 
36
 
35
 ## Try WebAR right now!
37
 ## Try WebAR right now!
36
 
38
 
37
 1. Scan or tap the QR code below with a mobile device.
39
 1. Scan or tap the QR code below with a mobile device.
38
-2. A web page will be opened. It's the WebAR experience.
40
+2. A [web page](https://alemart.github.io/martins-js/demo/) will be opened. It's the WebAR experience.
39
 3. The web page will request access to your webcam. Authorize it.
41
 3. The web page will request access to your webcam. Authorize it.
40
 4. Scan the cartoon below.
42
 4. Scan the cartoon below.
41
 5. Enjoy! :wink:
43
 5. Enjoy! :wink:
49
 > - Avoid low-quality cameras (cameras of common smartphones are OK).
51
 > - Avoid low-quality cameras (cameras of common smartphones are OK).
50
 >
52
 >
51
 
53
 
52
-[![WebAR demo](docs/demo/reference-image-with-qr-code.webp)](https://alemart.github.io/martins-js/demo/)
54
+[![WebAR demo](https://alemart.github.io/martins-js/demo/reference-image-with-qr-code.webp)](https://alemart.github.io/martins-js/demo/)
55
+
56
+Other demos available [here](https://alemart.github.io/martins-js/demos/).
57
+
58
+## Features
59
+
60
+Currently supported features:
61
+
62
+* **Image tracking**, also known as natural feature tracking. Use it to track detailed images such as: book covers, cartoons and photos.
53
 
63
 
54
 ## Browser compatibility
64
 ## Browser compatibility
55
 
65
 
59
 | ------ | ---- | ------- | ----- | ------ |
69
 | ------ | ---- | ------- | ----- | ------ |
60
 | ✔      | ✔    | ✔       | ✔     | -      |
70
 | ✔      | ✔    | ✔       | ✔     | -      |
61
 
71
 
62
-At the time of this writing, Safari is not yet compatible. MARTINS.js requires WebGL2 and WebAssembly.
72
+Safari support: coming soon.
73
+
74
+MARTINS.js requires WebGL2 and WebAssembly. No need of WebXR.
63
 
75
 
64
-## Contact
76
+## License
65
 
77
 
66
-[Get in touch!](https://alemart.github.io/martins-js/contact)
78
+Released under the [AGPL 3.0](LICENSE.md). A different license is available if you [support my work](https://alemart.github.io/martins-js/support-my-work).

+ 0
- 7
docs/contact.md 查看文件

1
-# Contact
2
-
3
-For technical questions, please [open an issue](https://github.com/alemart/martins-js/issues){ ._blank } on GitHub.
4
-
5
-For non-technical enquiries, contact me at alemartf at Google's email service dot com.
6
-
7
-For requesting a WebAR experience: [commissions open](https://ko-fi.com/alemart/commissions){ ._blank }!

+ 2
- 2
docs/demo/instructions.md 查看文件

7
 ## Follow the steps
7
 ## Follow the steps
8
 
8
 
9
 1. Scan or tap the QR code below with a mobile device.
9
 1. Scan or tap the QR code below with a mobile device.
10
-2. A web page will be opened. It's the WebAR experience.
10
+2. A [web page](./index.md) will be opened. It's the WebAR experience.
11
 3. The web page will request access to your webcam. Authorize it.
11
 3. The web page will request access to your webcam. Authorize it.
12
 4. Scan the cartoon below.
12
 4. Scan the cartoon below.
13
 5. Enjoy! :wink:
13
 5. Enjoy! :wink:
14
 
14
 
15
 !!! info "Guidelines for WebAR"
15
 !!! info "Guidelines for WebAR"
16
 
16
 
17
-    - WebGL2 and WebAssembly are required. Use a [compatible browser](../faq.md#what-about-browser-compatibility).
17
+    - WebGL2 and WebAssembly are required. Use a [compatible browser](../getting-started/index.md#browser-compatibility).
18
     - Don't move the camera too quickly - it produces motion blur.
18
     - Don't move the camera too quickly - it produces motion blur.
19
     - The physical environment should be properly illuminated.
19
     - The physical environment should be properly illuminated.
20
     - Avoid low-quality cameras (cameras of common smartphones are OK).
20
     - Avoid low-quality cameras (cameras of common smartphones are OK).

+ 4
- 10
docs/download.md 查看文件

1
 # Download
1
 # Download
2
 
2
 
3
-## Overview
3
+MARTINS.js can be downloaded from GitHub or used via a CDN. Read the [getting started](./getting-started/index.md) guide for information on how to add it to your web page.
4
 
4
 
5
-MARTINS.js can be downloaded from GitHub or used via a CDN.
5
+## Downloading from GitHub
6
 
6
 
7
-[:octocat: Download for free](https://github.com/alemart/martins-js/releases){ .md-button ._blank }
7
+[:octocat: Download now](https://github.com/alemart/martins-js/releases){ .md-button ._blank }
8
 
8
 
9
 ## Using a CDN
9
 ## Using a CDN
10
 
10
 
14
 <script src="https://cdn.jsdelivr.net/gh/alemart/martins-js@VERSION/dist/martins.min.js"></script>
14
 <script src="https://cdn.jsdelivr.net/gh/alemart/martins-js@VERSION/dist/martins.min.js"></script>
15
 ```
15
 ```
16
 
16
 
17
-Replace `VERSION` by ![GitHub release (latest by date)](https://img.shields.io/github/v/release/alemart/martins-js?color=%23ffffff&display_name=tag&label=%20)
18
-
19
-## License
20
-
21
-MARTINS.js is dual-licensed. It can be used for free under the [AGPL 3.0](./license/agpl-3.0.md). Any software developed with it must be free software. If you're doing personal experiments, or if you're a student, a hobbyist or a developer of free and open-source software, you may use it for free.
22
-
23
-If you intend to use MARTINS.js in a commercial, proprietary software, [get in touch](./contact.md) for a different license.
17
+Replace `VERSION` by ![GitHub release (latest by date)](https://img.shields.io/github/v/release/alemart/martins-js?color=%23ffffff&display_name=tag&label=%20)

+ 1
- 21
docs/faq.md 查看文件

22
 
22
 
23
     Fixing the orientation of the model is the preferred solution. However, you can also fix the issue with code: add a node (entity) to the scene graph and make it rotate its children by 90 degrees around the x-axis.
23
     Fixing the orientation of the model is the preferred solution. However, you can also fix the issue with code: add a node (entity) to the scene graph and make it rotate its children by 90 degrees around the x-axis.
24
 
24
 
25
-## What about browser compatibility?
26
-
27
-MARTINS.js is currently compatible with the latest versions of almost all major web browsers:
28
-
29
-| Chrome | Edge | Firefox | Opera | Safari |
30
-|:------:|:----:|:-------:|:-----:|:------:|
31
-| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - |
32
-
33
-At the time of this writing, Safari is not yet compatible. MARTINS.js requires WebGL2 and WebAssembly.
34
-
35
-## What about the licensing?
36
-
37
-MARTINS.js is dual-licensed. It can be used for free under the [AGPL 3.0](./license/agpl-3.0.md). Any software developed with it must be free software. If you're doing personal experiments, or if you're a student, a hobbyist or a developer of free and open-source software, you may use it for free.
38
-
39
-If you intend to use MARTINS.js in a commercial, proprietary software, [get in touch](./contact.md) for a different license.
40
-
41
 ## How can I contact you?
25
 ## How can I contact you?
42
 
26
 
43
-[Get in touch](./contact.md)!
44
-
45
-## How can I support you?
46
-
47
-[:heart:{ .heart } Support my work](./support-my-work.md){ .md-button }
27
+[Get in touch!](https://github.com/alemart)
48
 
28
 
49
 ## I love WebAR!
29
 ## I love WebAR!
50
 
30
 

+ 2
- 2
docs/getting-started/create-the-augmented-scene.md 查看文件

32
 
32
 
33
 I provide easy-to-use glue codes that work with different 3D rendering technologies in my demos, so that you don't need to deal with the complexity. Those glue codes are JavaScript (.js) files. You just need to add a glue code to your web page (e.g., via a `<script>` tag) and then the integration will be done for you. It's really that simple! Also, my glue codes may be used in both free and non-free projects.
33
 I provide easy-to-use glue codes that work with different 3D rendering technologies in my demos, so that you don't need to deal with the complexity. Those glue codes are JavaScript (.js) files. You just need to add a glue code to your web page (e.g., via a `<script>` tag) and then the integration will be done for you. It's really that simple! Also, my glue codes may be used in both free and non-free projects.
34
 
34
 
35
-[Get the glue codes in my demos](../demos.md){ .md-button ._blank }
36
-
37
 [:octocat: Get the glue codes on GitHub](https://github.com/alemart/martins-js/tree/master/dist){ .md-button ._blank }
35
 [:octocat: Get the glue codes on GitHub](https://github.com/alemart/martins-js/tree/master/dist){ .md-button ._blank }
38
 
36
 
37
+[Get the glue codes in my demos](../demos.md){ .md-button ._blank }
38
+
39
 ## Create the virtual scene
39
 ## Create the virtual scene
40
 
40
 
41
 Once you plug in the glue code, you'll be using the 3D rendering technology of your choice to create the virtual scene. The physical scene will be automatically augmented with the virtual scene, thus creating the augmented scene.
41
 Once you plug in the glue code, you'll be using the 3D rendering technology of your choice to create the virtual scene. The physical scene will be automatically augmented with the virtual scene, thus creating the augmented scene.

+ 26
- 10
docs/getting-started/index.md 查看文件

4
 
4
 
5
 **MARTINS.js** is a GPU-accelerated Augmented Reality engine for the web. It's a standalone WebAR technology for creating AR experiences that run in web browsers. Users don't need specialized hardware nor dedicated software - only a modern and compatible web browser.
5
 **MARTINS.js** is a GPU-accelerated Augmented Reality engine for the web. It's a standalone WebAR technology for creating AR experiences that run in web browsers. Users don't need specialized hardware nor dedicated software - only a modern and compatible web browser.
6
 
6
 
7
-[Learn WebAR](./introduction.md){ .md-button .md-button--primary } [Try a demo](../demo/instructions.md){ .md-button }
7
+[Learn WebAR](./introduction.md){ .md-button .md-button--primary } [Try a demo](../demo/instructions.md){ .md-button } [:heart:{ .heart } Support my work](../support-my-work.md){ .md-button }
8
 
8
 
9
-## Features
9
+:man_technologist: MARTINS.js is developed by [Alexandre Martins](https://github.com/alemart) and is based on [Speedy Vision](https://github.com/alemart/speedy-vision).
10
 
10
 
11
-Currently supported features:
11
+:books: Full documentation is available at <https://alemart.github.io/martins-js/>.
12
 
12
 
13
-* **Image tracking**, also known as natural feature tracking. Use it to track detailed images such as: book covers, cartoons and photos.
13
+:mailbox: [Contact me](https://github.com/alemart) for freelance work if you're not a developer.
14
+
15
+## What can you do with Web-based Augmented Reality?
16
+
17
+Lots of exciting things that run in the web browser!
18
+
19
+* Marketing gimmicks
20
+* WebAR Games
21
+* Interactive art
22
+* Tech demos
23
+* ...and more!
14
 
24
 
15
-![WebAR demo](../img/demo-aframe.gif) ![WebAR demo](../img/demo-hello.gif)
25
+[Try a demo!](../demo/instructions.md)
16
 
26
 
17
 ## Why use MARTINS.js?
27
 ## Why use MARTINS.js?
18
 
28
 
21
 * **No need to download apps!** MARTINS.js is a WebAR engine. It runs in web browsers. Users can access the AR experience immediately.
31
 * **No need to download apps!** MARTINS.js is a WebAR engine. It runs in web browsers. Users can access the AR experience immediately.
22
 * **Fast and powerful!** MARTINS.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
32
 * **Fast and powerful!** MARTINS.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
23
 * **No need of custom hardware or software!** MARTINS.js is built from scratch using standard web technologies. All it requires is a modern and compatible web browser.
33
 * **No need of custom hardware or software!** MARTINS.js is built from scratch using standard web technologies. All it requires is a modern and compatible web browser.
24
-* **Fully standalone!** MARTINS.js has in it everything it needs to analyze the environment and help you create AR. There are no additional requirements. It's not WebXR.
34
+* **Fully standalone!** MARTINS.js has in it everything it needs to analyze the environment and help you create AR. There are no additional requirements. No need of WebXR.
25
 * **Easy to get started!** MARTINS.js can be used with a `<script>` tag in your page. A static HTML page is enough to get started.
35
 * **Easy to get started!** MARTINS.js can be used with a `<script>` tag in your page. A static HTML page is enough to get started.
26
 
36
 
37
+## Features
38
+
39
+Currently supported features:
40
+
41
+* **Image tracking**, also known as natural feature tracking. Use it to track detailed images such as: book covers, cartoons and photos.
42
+
27
 ## Browser compatibility
43
 ## Browser compatibility
28
 
44
 
29
 MARTINS.js is currently compatible with the latest versions of almost all major web browsers:
45
 MARTINS.js is currently compatible with the latest versions of almost all major web browsers:
32
 |:------:|:----:|:-------:|:-----:|:------:|
48
 |:------:|:----:|:-------:|:-----:|:------:|
33
 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - |
49
 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - |
34
 
50
 
35
-At the time of this writing, Safari is not yet compatible. MARTINS.js requires WebGL2 and WebAssembly.
51
+Safari support: coming soon.
36
 
52
 
37
-## Author
53
+MARTINS.js requires WebGL2 and WebAssembly. No need of WebXR.
38
 
54
 
39
-MARTINS.js is developed independently by [Alexandre Martins](https://github.com/alemart) and is [dual-licensed](../faq.md#what-about-the-licensing).
55
+## License
40
 
56
 
41
-[:heart:{ .heart } Support my work](../support-my-work.md){ .md-button }
57
+Released under the [AGPL 3.0](../license/agpl-3.0.md). A different license is available if you [support my work](../support-my-work.md).

+ 6
- 6
docs/support-my-work.md 查看文件

1
 # Support my work
1
 # Support my work
2
 
2
 
3
-Creating this WebAR engine required a lot of time, effort, skill and specialized knowledge. Please support my work today, so that I can make it even more awesome!
3
+MARTINS.js is developed independently. Creating this WebAR engine required a lot of time, effort, skill and specialized knowledge. Please support my work today, so that I can make it even more awesome!
4
 
4
 
5
-* If you want to buy me a coffee, support me on Ko-fi:
5
+* If you're interested in the continuance of this work, please support it via GitHub Sponsors:
6
 
6
 
7
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J41O00K){ ._blank }
7
+[:octocat: Support me on GitHub Sponsors](https://github.com/sponsors/alemart/){ ._blank .md-button }
8
 
8
 
9
-* If you're very interested in WebAR, support this work monthly via GitHub Sponsors:
9
+* If you just want to buy me a coffee, use Ko-fi:
10
 
10
 
11
-[:octocat: Support me on GitHub Sponsors](https://github.com/sponsors/alemart/){ ._blank .md-button }
11
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J41O00K){ ._blank }
12
 
12
 
13
-Any questions? [Contact me](./contact.md).
13
+A commercial-friendly license is available if you support my work. :mailbox: [Contact me](https://github.com/alemart) for details.

+ 6
- 12
mkdocs.yml 查看文件

50
 nav:
50
 nav:
51
   - 'Home': 'index.md'
51
   - 'Home': 'index.md'
52
   - 'Getting started':
52
   - 'Getting started':
53
-    - 'Welcome to MARTINS.js': 'getting-started/index.md'
54
-    - 'Crash course on WebAR':
53
+    - 'Welcome': 'getting-started/index.md'
54
+    - 'Download': 'download.md'
55
+    - 'WebAR Crash Course':
55
       - 'Introduction': 'getting-started/introduction.md'
56
       - 'Introduction': 'getting-started/introduction.md'
56
       - 'Concepts': 'getting-started/concepts.md'
57
       - 'Concepts': 'getting-started/concepts.md'
57
       - 'Set up a web server': 'getting-started/set-up-a-web-server.md'
58
       - 'Set up a web server': 'getting-started/set-up-a-web-server.md'
61
       - 'Activate your webcam': 'getting-started/activate-your-webcam.md'
62
       - 'Activate your webcam': 'getting-started/activate-your-webcam.md'
62
       - 'Next steps': 'getting-started/next-steps.md'
63
       - 'Next steps': 'getting-started/next-steps.md'
63
     - 'Guidelines for Images': 'getting-started/guidelines-for-images.md'
64
     - 'Guidelines for Images': 'getting-started/guidelines-for-images.md'
64
-  - 'Download':
65
-    - 'Download': 'download.md'
65
+    - 'Support my work': 'support-my-work.md'
66
     - 'Questions & Answers': 'faq.md'
66
     - 'Questions & Answers': 'faq.md'
67
-    - 'Licenses':
68
-      - 'AGPL 3.0': 'license/agpl-3.0.md'
69
-      - 'Polyform Perimeter 1.0.0': 'license/PolyForm-Perimeter-1.0.0-1.md'
67
+    - 'Contribute': 'CONTRIBUTING.md'
70
   - 'Demos':
68
   - 'Demos':
71
     - 'Demo gallery': 'demos.md'
69
     - 'Demo gallery': 'demos.md'
72
     - 'Try WebAR now!': 'demo/instructions.md'
70
     - 'Try WebAR now!': 'demo/instructions.md'
113
       - 'Speedy': 'api/speedy.md'
111
       - 'Speedy': 'api/speedy.md'
114
       - 'SpeedySize': 'api/speedy-size.md'
112
       - 'SpeedySize': 'api/speedy-size.md'
115
       - 'SpeedyMatrix': 'api/speedy-matrix.md'
113
       - 'SpeedyMatrix': 'api/speedy-matrix.md'
116
-      - 'SpeedyPromise': 'api/speedy-promise.md'
117
-  - 'Contact':
118
-    - 'Contact': 'contact.md'
119
-    - 'Support my work': 'support-my-work.md'
120
-    - 'Contributing': 'CONTRIBUTING.md'
114
+      - 'SpeedyPromise': 'api/speedy-promise.md'

Loading…
取消
儲存