Skip to content

Commit

Permalink
📝 Add a repo structure & tools section to Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CosmoMyzrailGorynych committed Aug 15, 2019
1 parent 635fd24 commit bfdbebc
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,24 @@

Ct.js is a 2D game editor that makes its bet on good documentation, visual tools and smooth workflow.

For general support, ask a question at our [discord server](https://discord.gg/CggbPkb).
For bugs, feature requests, developing questions, please use [GitHub issues](https://github.com/ct-js/ct-js/issues) so we can better track them. For general support about making games, ask a question at our [discord server](https://discord.gg/CggbPkb).

# How to set up
# Repo structure & tools

* `app` — an [NW.js app](https://nwjs.io/), with its configs and static files.
* `src` — a source folder that compile into `/app` folder at a build time.
* `js` — different top-level scripts, including 3rd-party libraries.
* `pug` — HTML sources of editor's windows, written in [Pug](https://pugjs.org/).
* `riotTags` — components that drive all the logic in ct.js. Written in [Pug](https://pugjs.org/) and [Riot.js v3](https://v3.riotjs.now.sh/).
* `styl` — style sheets, written in [Stylus](http://stylus-lang.com/).
* `branding` — logos and icons belong here.
* `docs` — official docs of ct.js. Edit them [here](https://github.com/ct-js/docs.ctjs.rocks).
* `DragonBonesJS` — a dependency for enabling DragonBones' skeletal animation support in ct.js.
* `SSCD.js`[a fork](https://github.com/CosmoMyzrailGorynych/SSCD.js) of a collision library for ct.place.

# Forking and installing the dev environment

Building ct.js requires [Node and npm](https://nodejs.org/en/download/) installed on your machine.

```sh
git clone [email protected]:CoMiGo/ctjs.git ctjs
Expand Down

0 comments on commit bfdbebc

Please sign in to comment.