fullscreen/Documentation
0
0
Fork 0
mirror of https://github.com/FullScreenShenanigans/Documentation.git synced 2026-04-28 13:03:28 -07:00
Code Issues Packages Projects Releases Wiki Activity

Consolidated Development.md, Getting Started.md

Browse Source
This commit is contained in:
Josh Goldberg
2017-05-08 23:27:24 -07:00
parent af2ff9b7d1
commit 6dc1725379
2 changed files with 13 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Development.md
+9 -5
View File
@@ -15,7 +15,7 @@ It's recommended to use [Visual Studio Code](https://code.visualstudio.com/) as
### `shenanigans-manager`
Use `shenanigans-manager`'s `complete-setup` command to set up a directory with all the relevant FullScreenShenanigans projects linked to each other.
`shenanigans-manager`'s `complete-setup` command sets up a directory with all the relevant FullScreenShenanigans projects.
Using a shell / command prompt with administrative privileges:
@@ -24,8 +24,8 @@ npm install -g shenanigans-manager gulp
shenanigans-manager complete-setup --directory C:/Code/Shenanigans
```
After this, all the repositories will be fully built.
Their `node_modules` dependencies will by symbolically linked to each other.
After this, all the repositories will be cloned and fully built.
Their `node_modules` dependencies will be symlinked to each other.
You can launch Code in a project by starting it on the command-line and passing it a directory.
@@ -48,9 +48,13 @@ This will trigger incremental compilation whenever a source file changes.
### `src` and `test`
The `tsconfig.json` for files under `/src` is located in the root of the project, but a different one exists at `/test/tsconfig.json` for test files.
The two directories have separate build steps and will both output compiled files next to their source equivalents.
The root `/tsconfig.json` is used for files under `/src`.
A different one exists at `/test/tsconfig.json` for test files.
The two directories will both output compiled files next to their source equivalents and have separate build steps.
### Testing
You can run tests using `gulp test` or by opening `/test/index.html` in a browser.
If you add, remove, or rename a test file, you'll need to run `gulp setup` to re-initialize the test harness.
See the [`gulp-shenanigans` documentation](https://github.com/FullScreenShenanigans/gulp-shenanigans/blob/master/README.md#builds) for details on how to build, test, and run individual projects.
Getting Started.md
+4 -27
View File
@@ -1,35 +1,12 @@
This is the general getting started guide for all FullScreenShenanigans projects. The guide will show you how to download and run any FullScreenShenanigans game as well as teach you about how to use the console to interact with the game.
## Obtaining the Source Code
## Development
All FullScreenShenanigans projects are within the FullScreenShenanigans organization on GitHub.
For example, FullScreenPokemon is available at https://github.com/FullScreenShenanigans/FullScreenPokemon.
Use Git to clone the repository from GitHub:
1. If you don't already have Git installed on your computer, go to [this page](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and follow the instructions to download and install Git.
2. Follow [these directions](https://help.github.com/articles/cloning-a-repository/) to clone the repository.
3. See [Build Process](#build-process) to see how to build and play the game.
First set up your system using the steps in [Development](https://github.com/FullScreenShenanigans/Documentation/blob/master/Things.md).
## Build Process
FullScreenShenanigans projects use [Gulp](http://gulpjs.com/) to build, which requires you to [download and install Node.js](http://nodejs.org) first.
Go to the root repository folder and run the following commands:
```cmd
npm install -g gulp
npm install
gulp
```
You can now play the game by opening src/index.html in a browser.
See [gulp-shenanigans](https://github.com/FullScreenShenanigans/gulp-shenanigans) for details on build processes.
### Using the Console
## Using the Console
You can use your browser's developer tools to interact with the game.
FullScreenShenanigans projects store their game instances globally with an acronym for the project title.
@@ -42,7 +19,7 @@ setTimeout(() => FSP.gamesRunner.play(), 1000);
In this case, `FSP` is the acronym for FullScreenPokemon.
## Development
## Tutorials
There's no definitive guide through the documentation yet.
For now, read through guides in this order: