Skip to content

Commit 87c753e

Browse files
author
CubeCoders
committed
Initial public release of Jet
0 parents  commit 87c753e

45 files changed

Lines changed: 10563 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/docs.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Publish Doxygen to GitHub Pages
2+
3+
# Build the Doxygen HTML on every push to the default branch and publish
4+
# it to GitHub Pages. To enable: in the repository settings, set
5+
# Settings -> Pages -> Source = "GitHub Actions". No other configuration
6+
# is needed; the workflow uses the official actions/deploy-pages action
7+
# and the GITHUB_TOKEN that GitHub provides automatically.
8+
9+
on:
10+
push:
11+
branches: [main]
12+
workflow_dispatch:
13+
14+
# Only one concurrent Pages deployment at a time. Cancel in-progress
15+
# runs when a newer commit lands so we never publish a stale doc set.
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: true
19+
20+
permissions:
21+
contents: read
22+
pages: write
23+
id-token: write
24+
25+
jobs:
26+
build:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v4
31+
32+
- name: Install Doxygen + Graphviz
33+
run: |
34+
sudo apt-get update
35+
sudo apt-get install -y --no-install-recommends doxygen graphviz
36+
37+
- name: Run Doxygen
38+
working-directory: src
39+
run: doxygen Doxyfile
40+
41+
- name: Upload Pages artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
# Doxyfile sets OUTPUT_DIRECTORY=docs, HTML_OUTPUT=html, so the
45+
# generated site lives at src/docs/html relative to the repo
46+
# root. Adjust if you move the Doxyfile.
47+
path: src/docs/html
48+
49+
deploy:
50+
needs: build
51+
runs-on: ubuntu-latest
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
steps:
56+
- name: Deploy to GitHub Pages
57+
id: deployment
58+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Build outputs
2+
build/
3+
build-*/
4+
*.user
5+
.vs/
6+
7+
# Generated docs
8+
src/docs/html/
9+
src/docs/latex/

‎CONTRIBUTING.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing to Jet
2+
3+
Contributions are welcome — bug reports, fixes, new platforms, new examples,
4+
documentation improvements, all of it. Please open an issue or pull request
5+
on the official repository.
6+
7+
## Contributor Licence Agreement (CLA)
8+
9+
Jet is offered under **both** the AGPL and a separate commercial licence
10+
(see [README.md](README.md#licensing)). Every contributor to the official
11+
repository must agree to the following before their contribution can be
12+
merged:
13+
14+
> **Jet Contributor Licence Agreement**
15+
>
16+
> By submitting a contribution (code, documentation, examples, build system
17+
> changes, or any other material) to the official Jet repository — whether by
18+
> pull request, patch, commit, issue attachment, or any other means — you
19+
> ("Contributor") acknowledge and agree that:
20+
>
21+
> 1. **You have the right to contribute.** The contribution is your original
22+
> work, or you have obtained sufficient rights from the actual author(s)
23+
> and from any employer or other party with a claim to it, to submit it
24+
> under this agreement.
25+
>
26+
> 2. **You grant CubeCoders a broad licence.** You grant CubeCoders Limited
27+
> ("CubeCoders") a perpetual, worldwide, irrevocable, non-exclusive,
28+
> royalty-free, sub-licensable licence to use, reproduce, modify, prepare
29+
> derivative works of, publicly display, publicly perform, sub-license,
30+
> and distribute your contribution and such derivative works.
31+
>
32+
> 3. **You authorise relicensing.** You explicitly acknowledge and agree
33+
> that CubeCoders may relicense your contribution — in whole or in part,
34+
> in original or modified form, alone or as part of a larger work — under
35+
> licence terms of CubeCoders's choosing, including **proprietary,
36+
> closed-source, and commercial licence terms**, and may sell licences
37+
> to that work for any or no consideration. This is what allows the
38+
> commercial Jet licence offered at
39+
> <https://cubecoders.com/jet> to continue to exist alongside the
40+
> open-source AGPL version.
41+
>
42+
> 4. **The open-source version remains open.** Nothing in this agreement
43+
> permits CubeCoders to make the upstream public open-source release of
44+
> Jet anything other than copyleft (AGPL or a successor copyleft licence).
45+
> Your contribution will continue to be available under the AGPL to the
46+
> public.
47+
>
48+
> 5. **You retain copyright.** You retain ownership of the copyright in
49+
> your contribution. This agreement is a licence grant, not an
50+
> assignment.
51+
>
52+
> 6. **No warranty.** You provide your contribution "as-is", without warranty
53+
> of any kind, to the maximum extent permitted by law.
54+
55+
By opening a pull request against the official Jet repository (or pushing
56+
directly to it, if you have commit rights), you confirm that you have read,
57+
understood and agreed to the above. Contributions from authors who do not
58+
agree cannot be accepted into the official tree, but you remain free, under
59+
the AGPL, to maintain your own fork.
60+
61+
If you are contributing on behalf of a company, you are confirming that you
62+
are authorised by your employer to enter into this agreement, or that the
63+
contribution is otherwise outside the scope of your employer's claims.

0 commit comments

Comments
 (0)