Skip to content
Newer
Older
100644 115 lines (77 sloc) 3.64 KB
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 21, 2011
1 Subway
2 ======
04e52b3 Adding a README
David authored Dec 20, 2011
3
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored Jan 28, 2012
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
7490d57 Updating readme
David Petersen authored Feb 20, 2012
7 websockets (or best available fallback) via socket.io. If the the user is
8 logged in the client will stay persistant and log the channel why the user is
9 away.
10
11 The inspiration from this project was trying to watch a fellow programmer try
12 to explain how to set up screen/irssi to a non-technical person.
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
13
11faffe Updating readme
David Petersen authored Feb 20, 2012
14 Subway is built with [node.js](http://nodejs.org/),
15 Martyn Smith's [node-irc](https://github.com/martynsmith/node-irc), and MongoDB on the backend,
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
16 and [Backbone.js](http://documentcloud.github.com/backbone/) and
17 [jQuery](http://jquery.com/) on the frontend.
18
d4f8fff Update readme
David Petersen authored Feb 20, 2012
19 **[Try Subway on RideZap](http://ridezap.com:3000)**
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
20
7490d57 Updating readme
David Petersen authored Feb 21, 2012
21 Screenshots
22 ------------
23 ![Overview](http://people.oregonstate.edu/~petersed/overview.png)
24 ![Chat](http://people.oregonstate.edu/~petersed/chat.png)
25
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
26 Installation
27 ------------
28
29 *Should be something like this, once implemented:*
30
7490d57 Updating readme
David Petersen authored Feb 21, 2012
31 1. Assuming you already have node.js, npm, and mongo, run:
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
32
33 $ npm install -g subway
34
35 2. Launch the web server
36
ee81841 Fixing mistake in README
David authored Dec 29, 2011
37 $ node bin/subway
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
38
7490d57 Updating readme
David Petersen authored Feb 21, 2012
39 3. Point your browser at `http://localhost:3000/`
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
40
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored Jan 29, 2012
41
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
42 Development
43 -----------
44
45 *Should be about like this, once implemented:*
46
47 Replace step 1 above with this:
48
49 $ git clone https://github.com/thedjpetersen/subway.git
50 $ cd subway
51 $ npm link
52
53 this should install dependencies, and link the git checkout to your global
54 node_modules directory.
55
0dc270b Update README.md
David Petersen authored Feb 21, 2012
56 Discussion on the client takes place on the freenode channel #subway.
57
58
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored Jan 29, 2012
59
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
60 History
61 -------
62
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored Jan 28, 2012
63 Subway is a combination of two projects that started independently
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
64 with a similar technology stack and similar aims:
65
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored Jan 28, 2012
66 - [subway-web](https://github.com/thedjpetersen/subway-web) /
a0044eb @akavlie Formatting changes.
akavlie authored Dec 21, 2011
67 [subway-server](https://github.com/thedjpetersen/subway-server)
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
68 by David Petersen
69 - [web-irc](https://github.com/akavlie/web-irc) by Aaron Kavlie
70
71 Its goals are twofold:
72 1) Become the best web-based IRC client available
73 2) Provide a really easy method of persistent IRC connections, available
74 from any web browser
75
76
002f40a @akavlie Add credits to README.
akavlie authored Jan 28, 2012
77 Credits
78 -------
79
80 Major Subway contributors include:
81
82 - [David Petersen](https://github.com/thedjpetersen), developer
83 - [Aaron Kavlie](https://github.com/akavlie), developer
84 - [Jamie Soar](http://www.jamiesoarmusic.co.uk/), notification sounds
306eb41 @thedjpetersen Updating README
authored Jan 29, 2012
85 - 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 Jan 29, 2012
86
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored Jan 28, 2012
87
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
88 License
89 -------
90
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored Jan 28, 2012
91 Excepting third-party assets (licensed as specified in their respective files
92 or directories), this project is covered by the MIT License:
93
94
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored Dec 22, 2011
95 The MIT License (MIT)
96 Copyright (c) 2011 David Petersen
97
98 Permission is hereby granted, free of charge, to any person obtaining a copy of
99 this software and associated documentation files (the "Software"), to deal in
100 the Software without restriction, including without limitation the rights to
101 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
102 of the Software, and to permit persons to whom the Software is furnished to do
103 so, subject to the following conditions:
104
105 The above copyright notice and this permission notice shall be included in all
106 copies or substantial portions of the Software.
107
108 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
109 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
110 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
111 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
112 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
113 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
114 SOFTWARE.
Something went wrong with that request. Please try again.