Przeglądaj źródła

Simplify

customisations
alemart 3 lat temu
rodzic
commit
f0cd2e9325

+ 23
- 24
README.md Wyświetl plik

@@ -1,15 +1,14 @@
1 1
 # MARTINS.js WebAR engine
2 2
 
3
-Create amazing Augmented Reality experiences with **MARTINS.js**, a GPU-accelerated Augmented Reality engine for the web.
3
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/alemart/martins-js)](https://github.com/alemart/martins-js/releases/)
4
+![GitHub file size in bytes on a specified ref (branch/commit/tag)](https://img.shields.io/github/size/alemart/martins-js/dist/martins.min.js?branch=master&label=minified%20js)
5
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github)](https://github.com/sponsors/alemart/)
4 6
 
5
-**Get started at <https://alemart.github.io/martins-js/>**
7
+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 8
 
7
-MARTINS.js is [developed independently](#author). It is currently in beta.
9
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J41O00K)
8 10
 
9
-| |
10
-|-|
11
-| :octocat: [**Support my work on GitHub Sponsors!**](https://github.com/sponsors/alemart/) |
12
-| |
11
+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).
13 12
 
14 13
 ## Features
15 14
 
@@ -19,6 +18,22 @@ Currently supported features:
19 18
 
20 19
 ![WebAR demo](docs/img/demo-aframe.gif) ![WebAR demo](docs/img/demo-hello.gif)
21 20
 
21
+## Why use MARTINS.js?
22
+
23
+Here is why MARTINS.js is a great choice for creating Augmented Reality experiences:
24
+
25
+* **No need to download apps!** MARTINS.js is a WebAR engine. It runs in web browsers. Users can access the AR experience immediately.
26
+* **Fast and powerful!** MARTINS.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
27
+* **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.
28
+* **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.
29
+* **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.
30
+
31
+## Documentation
32
+
33
+Full documentation is available at <https://alemart.github.io/martins-js/>.
34
+
35
+Cool demos are available at <https://alemart.github.io/martins-js/demos/>.
36
+
22 37
 ## Try WebAR right now!
23 38
 
24 39
 1. Scan or tap the QR code below with a mobile device.
@@ -38,16 +53,6 @@ Currently supported features:
38 53
 
39 54
 [![WebAR demo](docs/demo/reference-image-with-qr-code.webp)](https://alemart.github.io/martins-js/demo/)
40 55
 
41
-## Why use MARTINS.js?
42
-
43
-Here is why MARTINS.js is a great choice for creating Augmented Reality experiences:
44
-
45
-* **No need to download apps!** MARTINS.js is a WebAR engine. It runs in web browsers. Users can access the AR experience immediately.
46
-* **Fast and powerful!** MARTINS.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
47
-* **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.
48
-* **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.
49
-* **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.
50
-
51 56
 ## Browser compatibility
52 57
 
53 58
 MARTINS.js is compatible with the latest versions of almost all major web browsers:
@@ -56,10 +61,4 @@ MARTINS.js is compatible with the latest versions of almost all major web browse
56 61
 | ------ | ---- | ------- | ----- | ------ |
57 62
 | ✔      | ✔    | ✔       | ✔     | -      |
58 63
 
59
-At the time of this writing, Safari is not yet compatible. MARTINS.js requires WebGL2 and WebAssembly.
60
-
61
-## Author
62
-
63
-MARTINS.js is developed independently by [Alexandre Martins](https://github.com/alemart) and is [dual-licensed](docs/faq.md#what-about-the-licensing).
64
-
65
-See [CONTRIBUTING](./docs/CONTRIBUTING.md) for information on how you can contribute.
64
+At the time of this writing, Safari is not yet compatible. MARTINS.js requires WebGL2 and WebAssembly.

+ 3
- 1
docs/download.md Wyświetl plik

@@ -11,9 +11,11 @@ MARTINS.js can be downloaded from GitHub or used via a CDN.
11 11
 Add the following to the `<head>` of your HTML page:
12 12
 
13 13
 ```html
14
-<script src="https://cdn.jsdelivr.net/gh/alemart/martins-js@0.1/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
+
17 19
 ## License
18 20
 
19 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.

+ 2
- 0
docs/getting-started/create-the-augmented-scene.md Wyświetl plik

@@ -34,6 +34,8 @@ I provide easy-to-use glue codes that work with different 3D rendering technolog
34 34
 
35 35
 [Get the glue codes in my demos](../demos.md){ .md-button ._blank }
36 36
 
37
+[:octocat: Get the glue codes on GitHub](https://github.com/alemart/martins-js/tree/master/dist){ .md-button ._blank }
38
+
37 39
 ## Create the virtual scene
38 40
 
39 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.

+ 1
- 1
docs/support-my-work.md Wyświetl plik

@@ -1,6 +1,6 @@
1 1
 # Support my work
2 2
 
3
-My name is Alexandre Martins and I develop this Augmented Reality engine 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!
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!
4 4
 
5 5
 * If you want to buy me a coffee, support me on Ko-fi:
6 6
 

+ 4
- 1
mkdocs.yml Wyświetl plik

@@ -114,4 +114,7 @@ nav:
114 114
       - 'SpeedySize': 'api/speedy-size.md'
115 115
       - 'SpeedyMatrix': 'api/speedy-matrix.md'
116 116
       - 'SpeedyPromise': 'api/speedy-promise.md'
117
-  - 'Contact': 'contact.md'
117
+  - 'Contact':
118
+    - 'Contact': 'contact.md'
119
+    - 'Support my work': 'support-my-work.md'
120
+    - 'Contributing': 'CONTRIBUTING.md'

Ładowanie…
Anuluj
Zapisz