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