https://github.com/zwrawr/ldguides

User guides for ludumdare
https://github.com/zwrawr/ldguides

Last synced: about 2 months ago
JSON representation

User guides for ludumdare

• Host: GitHub
• URL: https://github.com/zwrawr/ldguides
• Owner: zwrawr
• Created: 2017-06-04T18:44:29.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-04-20T21:59:49.000Z (over 5 years ago)
• Last Synced: 2024-02-20T21:52:20.969Z (10 months ago)
• Size: 33.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ludum Dare Guides

[![Build Status](https://travis-ci.org/zwrawr/LDguides.svg?branch=master)](https://travis-ci.org/zwrawr/LDguides)

## Overview

The purpose of this repo is to have a location where then user guides for the new Ludum Dare website can be easily collaborated on. This isn't official but i need somewhere to put these whilst i was working on them.

Checkout [Tree file](tree.md) for a list of files in this repo.

## Contributing

### Setup

If your just making a small change, GitHub's online editor works quite well.

For larger changes, you'll need to fork/clone this repo and then download it. Once you've downloaded it, you should run the following command to setup the project.

```bash

npm install

```

### Editing

Some things to remember when writing.

* These guides are intended to be 'official Ludum Dare' guides, try to make your writing style reflect this.

* A lot of these guides are intended for people who haven't been involved with Ludum Dare for long. They might well be read by people before there first LD! So don't assume too much knowledge of how Ludum Dare works.

### Testing

There two things you should do once you've completed your edits.

#### Proof read the files you've changed.

This is probably common sense, but you should reread you changes to make sure what you've written has made sense.

#### Run the test suite

Currently this is just a simple spell checker. It's set to use an American English \(`en-us`\) dictionary.

You can run the test in the command line using the command below. It should give you a color coded list of any spelling mistakes.

```text

npm test

```

You can run the interactive version of the spellchecker using the following command.

```text

npm run spellcheck

```

Correctly spelled works that are being reported as spelling mistakes should be added to the `.spelling` file. It's likely that you'll have to add user names, company names, technological words and Ludum dare specific phrases.

Our test suite is also run via Travis CI