Permalink
Browse files

Tidy up README.md and package.json

  • Loading branch information...
curiousdannii committed Dec 13, 2016
1 parent eb919cd commit 3207034495e47241f44d0b31672fdf3d400d346f
Showing with 17 additions and 27 deletions.
  1. +5 −11 README.md
  2. +12 −16 package.json
View
@@ -1,25 +1,19 @@
Parchment
=========
-Parchment is the Interactive Fiction player for the web. For more information see [our Google Code site](http://code.google.com/p/parchment). To play a story with it, go to <http://iplayif.com>!
+Parchment is the Interactive Fiction player for the web. To play a story with Parchment go to <http://iplayif.com>!
-Parchment is BSD licenced, but please help the community by sharing any changes you make with us.
+Most of Parchment is BSD licenced, except for Gunch which is GPL 3. Please use Parchment freely, but consider helping the community by sharing any changes you make with us.
Parchment for Inform 7
----------------------
-[Inform 7](http://inform7.com/) includes Parchment, allowing you to produce [personal websites for your stories](http://inform7.com/learn/man/doc394.html). If you want to update the version of Parchment used by Inform 7, grab [parchment-for-inform7.zip](https://raw.github.com/curiousdannii/parchment/master/lib/parchment-for-inform7.zip) and unzip it into the Templates subfolder of your project's Materials folder.
+[Inform 7](http://inform7.com/) includes Parchment, allowing you to produce [personal websites for your stories](http://inform7.com/learn/man/WI_25_11.html). If you want to update the version of Parchment used by Inform 7, grab [parchment-for-inform7.zip](https://raw.github.com/curiousdannii/parchment/master/lib/parchment-for-inform7.zip) and unzip it into the Templates subfolder of your project's Materials folder.
Building Parchment
-----------------
-We use [Node.js](http://nodejs.org/) and [Grunt](http://gruntjs.com/) to build and test Parchment. Install Node.js, and then install the grunt-cli package:
-
-```
-npm install -g grunt-cli
-```
-
-Then from the Parchment directory install our dependencies:
+We use [Node.js](http://nodejs.org/) and [Grunt](http://gruntjs.com/) to build and test Parchment. Install Node.js and then, from the Parchment directory, install our dependencies:
```
npm install
@@ -28,5 +22,5 @@ npm install
To build everything run the following:
```
-grunt
+npm run build
```
View
@@ -2,21 +2,14 @@
"name": "parchment",
"version": "0.1.0",
"description": "The Interactive Fiction player for the web",
- "author": {
- "name": "The Parchment team",
- "url": "https://github.com/curiousdannii/parchment/blob/master/CONTRIBUTORS"
- },
- "license": "BSD",
- "repository": {
- "type": "git",
- "url": "git://github.com/curiousdannii/parchment.git"
- },
- "bugs": {
- "url": "https://code.google.com/p/parchment/issues/list"
- },
- "dependencies": {
- "express": "~3.2.4"
- },
+ "author": "Dannii Willis <curiousdannii@gmail.com>",
+ "license": "GPL-3",
+ "keywords": [
+ "intfiction"
+ ],
+ "repository": "curiousdannii/parchment",
+ "homepage": "https://github.com/curiousdannii/parchment",
+ "bugs": "https://github.com/curiousdannii/parchment/issues",
"devDependencies": {
"grunt": "~0.4.1",
"grunt-contrib-concat": "~0.2.0",
@@ -26,5 +19,8 @@
"grunt-contrib-watch": "~0.3.1",
"grunt-update-submodules": "~0.2.0",
"grunt-zip": "~0.9.0"
+ },
+ "scripts": {
+ "build": "grunt"
}
-}
+}

0 comments on commit 3207034

Please sign in to comment.