z0w0 / helm

A functionally reactive game engine, with headgear to protect you from the headache of game development provided.
http://helm-engine.org/
MIT License
598 stars 69 forks source link

New website & documentation #108

Open z0w0 opened 7 years ago

z0w0 commented 7 years ago

The site needs to be redesigned around the release of 1.1. I'd like to see more straight forward examples on the site, and completely finished documentation.

--- Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/38061212-new-website-documentation?utm_campaign=plugin&utm_content=tracker%2F290443&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F290443&utm_medium=issues&utm_source=github).
AugmentedFifth commented 6 years ago

I'd like to help out with this -- I've started working directly with some of the HTML/CSS/JS that I ripped from the current website, and improved the existing tutorial stuff while adding a new tutorial section.

I'm not sure how the website is actually deployed on the back end or how the syntax highlighting was done, so I just let that stuff alone for now. What I have so far is located here: https://github.com/AugmentedFifth/helm-website-fragments

z0w0 commented 6 years ago

Good initiative. The website code is on gh-pages. Written using Jekkyl and auto-deployed/hosted on Github Pages.

AugmentedFifth commented 6 years ago

Oh, awesome. I can't seem to find the repository for it, though. Doesn't show up on any search engine results, and I don't see it on the website or under https://z0w0.github.io/ or any of your other repos.

z0w0 commented 6 years ago

It's under the gh-pages branch on this repo

AugmentedFifth commented 6 years ago

Ok, I've got a working GH Pages up here that has a fixed up/extended intro and guides as well as some changes to the CSS and another guide added on. The repo for it is here.

The guides there link to this repo for the example code.

My fork can't be merged quite yet, since I did a bit of a hack fix of adding /helm to the beginning of every relative URL to make them work with my GH Pages site. Switching between the two isn't difficult, I just wasn't sure what was the best way to handle it and wanted to make sure that I could deploy my version on GH Pages for development purposes.

EDIT: As a side note, I can't seem to get gradients with more than two stops to work as expected. This example code renders a rectangle that has a gradient from black to red, with no yellow whatsoever.

z0w0 commented 6 years ago

Cool work so far. It'd be cool if we could catch up on an IM chat - might setup a Slack channel or whatever - as I think the guide should move to using GitBook with the core concepts explained alongside some rudimentary examples. I'll be gone till next week though so won't be until thenish.

For the issue you found, could you open up another Github issue? Looking here, it should work as it just passes the color stops straight into Cairo.. https://github.com/z0w0/helm/blob/master/src/Helm/Engine/SDL/Engine.hs#L397

nikita-leonov commented 6 years ago

It seems that website includes a sample code for v0.7.1 and it is not compatible with 1.0.0. I understand there is a lot of priorities, but It will be nice to fix it first. This is what people starts from and I guess got confused right away as I did.

z0w0 commented 6 years ago

I've replaced the old snippet with the hello example. Can't say it looks that good cause without more text in the left column, but it's better than having a non-working example