Add info about "gfx" folder to Readme

Open
#88 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Start with the README's Quick Project Setup and XML Layout Basics sections, comparing how the existing xml directory guidance relates to the gfx path described in the issue. Update Quick Project Setup so the required gfx folder is clear, then verify that the wording matches the XML Layout Basics explanation.

Written by the indexing model from the issue text.

Description

Not a big deal actually

I was digging RPG Interface demo code
and seen that specified paths in XML files are relative to assets/gfx
So I was looking for info about this folder in Readme
https://github.com/HaxeFlixel/flixel-ui#quick-project-setup
and
then found it
https://github.com/HaxeFlixel/flixel-ui#xml-layout-basics

And I thought maybe you guys can add a note on gfx to
https://github.com/HaxeFlixel/flixel-ui#quick-project-setup

In your openfl assets folder, create an "xml" directory
Maybe add something like "create a gfx folder"

I got that "xml" directory is hard-coded pretty fast, but not "gfx" folder... Or maybe it's just to me

Dominant language
Haxe
Stars
201
Forks
75
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from HaxeFlixel/flixel-ui

All issues in HaxeFlixel/flixel-ui

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.