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

Improve and standardize README.md #41

Merged
merged 2 commits into from
Aug 16, 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: 3 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
open_collective: blue-fire
github: bluefireteam
patreon: bluefireoss
35 changes: 35 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: build

on:
push:
branches:
- main
pull_request:
types: [opened, reopened, synchronize]

jobs:
jekyll:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Setup ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.2.2

- name: Setup node
uses: actions/setup-node@v3
with:
node-version: 19.8.1

- name: Install npm dependencies
run: npm install

- name: Build Jekyll
uses: limjh16/jekyll-action-ts@v2
with:
enable_cache: true
format_output: true
prettier_opts: '{ "useTabs": true }'
2 changes: 1 addition & 1 deletion .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: GitHub Pages Deploy
name: gh-pages

on:
push:
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Flame Engine Site

<p align="center">
<a title="Deploy" href="https://github.com/flame-engine/flame-engine-site/actions?query=workflow%3Agh-pages+branch%3Amain"><img src="https://github.com/flame-engine/flame-engine-site/workflows/gh-pages/badge.svg?branch=main&event=push"/></a>
<a title="Discord" href="https://discord.gg/pxrBmy4"><img src="https://img.shields.io/discord/509714518008528896.svg"/></a>
</p>

This is the main landing page of the Flame Engine website; it is deployed [here](https://flame-engine.org) via GitHub Pages.

This was built using [Jekyll](https://jekyllrb.com/)! Please send them some 💙 from us.
Expand Down