UNPKG

8.85 kBMarkdownView Raw
1CrossBrowdy
2============
3by [Joan Alba Maldonado](https://joanalbamaldonado.com/ "Joan Alba Maldonado's home page") (joanalbamaldonadoNO_SPAM_PLEASE AT gmail DOT com, without NO_SPAM_PLEASE)
4
5Your cross-browser brodie!
6
7[CrossBrowdy](https://crossbrowdy.com/ "CrossBrowdy web site") is a Multimedia JavaScript framework that can be used to create real cross-platform and hybrid game engines, games, emulators, multimedia libraries and apps.
8
9It is compatible with web browsers, desktop and laptop computers, mobile devices (phones, tablets), desktop and handheld video game consoles, TV sets, smart watches, embedded devices and many others.
10
11It is open source and free.
12
13Main web site: [https://crossbrowdy.com/](https://crossbrowdy.com/ "CrossBrowdy web site")
14
15
16# About & FAQ
17Visit the [About & FAQ section](https://crossbrowdy.com/about "About & FAQ") to know more about [CrossBrowdy](https://crossbrowdy.com/ "CrossBrowdy web site").
18
19
20# Download
21To include it in your project and start using it, the most common way to download [CrossBrowdy](https://crossbrowdy.com/ "CrossBrowdy web site") for production is through the [Download section](https://crossbrowdy.com/download "Download CrossBrowdy") from the official web site.
22
23You can also download [CrossBrowdy](https://crossbrowdy.com/ "CrossBrowdy web site") from [the GitHub repository](https://github.com/jalbam/CrossBrowdy/ "CrossBrowdy's GitHub repository") directly. Just download the whole content of the **[dist/](https://github.com/jalbam/CrossBrowdy/blob/master/dist/)** folder.
24
25Alternatively, from the command line (shell), you can also use one of the following commands to download [CrossBrowdy](https://crossbrowdy.com/ "CrossBrowdy web site") while you are in your project folder:
26
27
28## Using **[Yarn](https://yarnpkg.com/en/package/crossbrowdy "CrossBrowdy's Yarn package")**:
29```
30yarn add crossbrowdy
31```
32
33
34## Using **[npm](https://www.npmjs.com/package/crossbrowdy "CrossBrowdy's npm package")**:
35```
36npm i crossbrowdy
37```
38
39
40## Using **Bower**:
41```
42bower install jalbam/crossbrowdy --save
43```
44
45**Note**: [Yarn](https://yarnpkg.com/en/package/crossbrowdy "CrossBrowdy's Yarn package"), [npm](https://www.npmjs.com/package/crossbrowdy "CrossBrowdy's npm package") and Bower will also download the [API documentation](https://crossbrowdy.com/api/ "CrossBrowdy API documentation").
46
47
48# Hotlinking
49Instead of downloading CrossBrowdy, you can [hotlink](https://en.wikipedia.org/wiki/Inline_linking) it by directly pointing to a version available online. For instance this way you will be pointing to the last version:
50```html
51<script src="https://crossbrowdy.com/CrossBrowdy/CrossBrowdy.js" type="text/javascript" language="javascript"></script><!-- "type" and "language" parameters for legacy clients. -->
52```
53You can find a list of some [CDN providers](https://en.wikipedia.org/wiki/Content_delivery_network) in the [Download section](https://crossbrowdy.com/download#cdn_providers "CDN providers for CrossBrowdy") of the official web site. Thanks to them, you will be able to always use the last up-to-date version or even to point to a specific version you may prefer.
54
55Have in mind that including the CrossBrowdy main file from a [CDN provider](https://en.wikipedia.org/wiki/Content_delivery_network) should never be done for production. This [hotlinking method](https://en.wikipedia.org/wiki/Inline_linking) can be useful just for testing purposes. Some features might not work properly using this way and availability cannot be always guaranteed.
56
57
58# Getting started
59Just include the main JavaScript file, which is called _CrossBrowdy.js_, in your HTML file. The recommended place to include this main JavaScript file is inside the head section (inside the [&lt;head&gt; tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/head)) of the document.
60
61## Here you have a simple example:
62```html
63<!DOCTYPE html>
64<html>
65 <head>
66 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
67 <title>My first CrossBrowdy project!</title>
68 <script src="CrossBrowdy/CrossBrowdy.js" type="text/javascript" language="javascript"></script><!-- "type" and "language" parameters for legacy clients. -->
69 <script type="text/javascript" language="javascript">
70 <!--
71 CB_init(main); //It will call the "main" function when ready.
72
73 //This function will be called when CrossBrowdy is ready:
74 function main()
75 {
76 //Now, you can start using CrossBrowdy here...
77 CB_console("CrossBrowdy started!");
78 }
79 // -->
80 </script>
81 </head>
82 <body>
83 <!-- The "CB_console" element will be used automatically in the case that the client does not support console: -->
84 <div id="CB_console" style="display:none; visibility:hidden; overflow:scroll;">
85 <span style="font-weight:bold;">Console:</span><br />
86 </div>
87 </body>
88</html>
89```
90Visit the [Getting started topic](https://crossbrowdy.com/basic_tutorial/general/getting_started/ "Getting started with CrossBrowdy") from the [Basic tutorial](https://crossbrowdy.com/guides#basic_tutorial "CrossBrowdy's Basic tutorial") to learn more.
91
92
93# Usage
94Visit the [Guides &amp; Tutorials section](https://crossbrowdy.com/guides "Guides &amp; Tutorials for CrossBrowdy") to get all the information you may need.
95
96
97# Learn
98Check the [Basic tutorial](https://crossbrowdy.com/guides#basic_tutorial "CrossBrowdy's Basic tutorial") to learn how to use it.
99
100
101# Examples
102Check the [Examples section](https://crossbrowdy.com/guides#examples "CrossBrowdy examples") to see some live examples and learn through their code.
103
104
105# API documentation
106For more technical documentation, visit the [API documentation section](https://crossbrowdy.com/api/ "CrossBrowdy API documentation").
107
108There is also a [structure diagram](https://crossbrowdy.com/api/crossbrowdy_structure_diagram.html) that can be useful to get an abstract idea about the logic structure used by [CrossBrowdy](https://crossbrowdy.com/ "CrossBrowdy web site").
109
110
111# News
112Visit the [News section](https://crossbrowdy.com/news "CrossBrowdy News") to keep up to date.
113
114
115# Help
116Check ["_I still have a problem, doubt or suggestion. What can I do?_"](https://crossbrowdy.com/about#i_have_a_problem_doubt_or_suggestion_what_can_i_do).
117
118
119# Community & Get Involved
120Visit the [Community & Get Involved section](https://crossbrowdy.com/community "Community & Get Involved") to access the [CrossBrowdy](https://crossbrowdy.com/ "CrossBrowdy web site") community through different ways and also to get involved and contribute with its development.
121
122Please, before contributing, do not forget to read first the [code of conduct](https://github.com/jalbam/CrossBrowdy/blob/master/CODE_OF_CONDUCT.md) and [contributing](https://github.com/jalbam/CrossBrowdy/blob/master/CONTRIBUTING.md) documents.
123
124
125# Credits
126CrossBrowdy project was created by [Joan Alba Maldonado (aka Juan Alba Maldonado)](https://joanalbamaldonado.com/ "Joan Alba Maldonado's home page").
127It also uses some external libraries and "third-party" code. The name of these libraries and the name of the authors of these libraries and that other code can be found in the source code as well as in the splash screen (if it was no disabled) and in the console when CrossBrowdy is loading. As this information may vary with each version, it is not included here.
128
129
130# License
131The content from the [API documentation](https://crossbrowdy.com/api/ "CrossBrowdy API documentation"), the content from the [official web site](https://crossbrowdy.com/ "CrossBrowdy web site"), including tutorials, examples, etc. created by [Joan Alba Maldonado (aka Juan Alba Maldonado)](https://joanalbamaldonado.com/ "Joan Alba Maldonado's home page") is licensed under a [Creative Commons Attribution 4.0 International license](https://creativecommons.org/licenses/by/4.0/) (SPDX short identifier: "_CC BY 4.0_").
132
133The code written by [Joan Alba Maldonado (aka Juan Alba Maldonado)](https://joanalbamaldonado.com/ "Joan Alba Maldonado's home page"), which genuinely belongs to the [CrossBrowdy](https://crossbrowdy.com/ "CrossBrowdy project") project, is licensed under the [2-Clause BSD License](https://choosealicense.com/licenses/bsd-2-clause/) (aka "_Simplified BSD License_" or "_FreeBSD License_", SPDX short identifier: "_BSD-2-Clause_").
134
135Apart from that, it is important to have into account that [CrossBrowdy](https://crossbrowdy.com/ "CrossBrowdy web site") uses some external libraries and some code which may have their own license each. It is important to respect each license properly as the responsibility will always lie with you.
136
137See more at ["_What is the CrossBrowdy's copyright and license?_"](https://crossbrowdy.com/about#what_is_the_crossbrowdy_copyright_and_license).
\No newline at end of file