Skip to content
Newer
Older
100644 103 lines (68 sloc) 3.26 KB
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
1 Subway
2 ======
04e52b3 Adding a README
David authored
3
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
4 *(Note: this is aspirational. Not implemented yet!)*
5
6 Subway is an IRC client/server combination. The server works for multiple simultaneous users, with optional persistent connections and logging. The client is a modern JavaScript-heavy web interface. Server/client communication is done with websockets (or best available fallback) via socket.io.
7
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
8 Subway utilizes [node.js](http://nodejs.org/) and
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
9 Martyn Smith's [node-irc](https://github.com/martynsmith/node-irc) on the backend,
10 and [Backbone.js](http://documentcloud.github.com/backbone/) and
11 [jQuery](http://jquery.com/) on the frontend.
12
13
14 Status
15 ------
16
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
17 Nothing works yet. Functionality to come shortly. If you'd like to contribute,
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
18 there is plenty to do. Tickets for needed functionality also to come shortly.
19
20 Installation
21 ------------
22
23 *Should be something like this, once implemented:*
24
25 1. Assuming you already have node.js & npm, run:
26
27 $ npm install -g subway
28
29 2. Launch the web server
30
ee81841 Fixing mistake in README
David authored
31 $ node bin/subway
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
32
33 3. Point your browser at `http://localhost:8337/`
34
35 Development
36 -----------
37
38 *Should be about like this, once implemented:*
39
40 Replace step 1 above with this:
41
42 $ git clone https://github.com/thedjpetersen/subway.git
43 $ cd subway
44 $ npm link
45
46 this should install dependencies, and link the git checkout to your global
47 node_modules directory.
48
49 History
50 -------
51
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
52 Subway is a combination of two projects that started independently
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
53 with a similar technology stack and similar aims:
54
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
55 - [subway-web](https://github.com/thedjpetersen/subway-web) /
a0044eb @akavlie Formatting changes.
akavlie authored
56 [subway-server](https://github.com/thedjpetersen/subway-server)
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
57 by David Petersen
58 - [web-irc](https://github.com/akavlie/web-irc) by Aaron Kavlie
59
60 Its goals are twofold:
61 1) Become the best web-based IRC client available
62 2) Provide a really easy method of persistent IRC connections, available
63 from any web browser
64
65
002f40a @akavlie Add credits to README.
akavlie authored
66 Credits
67 -------
68
69 Major Subway contributors include:
70
71 - [David Petersen](https://github.com/thedjpetersen), developer
72 - [Aaron Kavlie](https://github.com/akavlie), developer
73 - [Jamie Soar](http://www.jamiesoarmusic.co.uk/), notification sounds
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.