Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 103 lines (69 sloc) 3.297 kb
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
1 Subway
2 ======
04e52b3 Adding a README
David authored
3
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
4 Subway is an IRC client/server combination.
5 The server supports multiple simultaneous users. The client is a modern
6 JavaScript-heavy web interface. Client/server communication is done with
7 websockets (or best available fallback) via socket.io.
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
8
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
9 Subway is built with [node.js](http://nodejs.org/) and
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
10 Martyn Smith's [node-irc](https://github.com/martynsmith/node-irc) on the backend,
11 and [Backbone.js](http://documentcloud.github.com/backbone/) and
12 [jQuery](http://jquery.com/) on the frontend.
13
570b54d @akavlie Add link to Nodester deployment
akavlie authored
14 **[Try Subway on Nodester](http://subway.nodester.com)**
d4f8fff Update readme
David Petersen authored
15 **[Try Subway on RideZap](http://ridezap.com:3000)**
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
16
17 Installation
18 ------------
19
20 *Should be something like this, once implemented:*
21
22 1. Assuming you already have node.js & npm, run:
23
24 $ npm install -g subway
25
26 2. Launch the web server
27
ee81841 Fixing mistake in README
David authored
28 $ node bin/subway
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
29
30 3. Point your browser at `http://localhost:8337/`
31
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
32
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
33 Development
34 -----------
35
36 *Should be about like this, once implemented:*
37
38 Replace step 1 above with this:
39
40 $ git clone https://github.com/thedjpetersen/subway.git
41 $ cd subway
42 $ npm link
43
44 this should install dependencies, and link the git checkout to your global
45 node_modules directory.
46
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
47
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
48 History
49 -------
50
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
51 Subway is a combination of two projects that started independently
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
52 with a similar technology stack and similar aims:
53
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
54 - [subway-web](https://github.com/thedjpetersen/subway-web) /
a0044eb @akavlie Formatting changes.
akavlie authored
55 [subway-server](https://github.com/thedjpetersen/subway-server)
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
56 by David Petersen
57 - [web-irc](https://github.com/akavlie/web-irc) by Aaron Kavlie
58
59 Its goals are twofold:
60 1) Become the best web-based IRC client available
61 2) Provide a really easy method of persistent IRC connections, available
62 from any web browser
63
64
002f40a @akavlie Add credits to README.
akavlie authored
65 Credits
66 -------
67
68 Major Subway contributors include:
69
70 - [David Petersen](https://github.com/thedjpetersen), developer
71 - [Aaron Kavlie](https://github.com/akavlie), developer
72 - [Jamie Soar](http://www.jamiesoarmusic.co.uk/), notification sounds
306eb41 @thedjpetersen Updating README
authored
73 - Some icons by Yusuke Kamiyamane. All rights reserved. Licensed under a Creative Commons Attribution 3.0 License.
002f40a @akavlie Add credits to README.
akavlie authored
74
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
75
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
76 License
77 -------
78
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
79 Excepting third-party assets (licensed as specified in their respective files
80 or directories), this project is covered by the MIT License:
81
82
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
83 The MIT License (MIT)
84 Copyright (c) 2011 David Petersen
85
86 Permission is hereby granted, free of charge, to any person obtaining a copy of
87 this software and associated documentation files (the "Software"), to deal in
88 the Software without restriction, including without limitation the rights to
89 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
90 of the Software, and to permit persons to whom the Software is furnished to do
91 so, subject to the following conditions:
92
93 The above copyright notice and this permission notice shall be included in all
94 copies or substantial portions of the Software.
95
96 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
97 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
98 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
99 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
100 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
101 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
102 SOFTWARE.
Something went wrong with that request. Please try again.