Mercurial > eldonilo > avatar
comparison README @ 11:1cb2279e3f30
Improve the README.
author | Bruno Michel <bmichel@menfin.info> |
---|---|
date | Thu, 02 Jun 2011 00:10:06 +0200 |
parents | a637cde69f71 |
children |
comparison
equal
deleted
inserted
replaced
10:a637cde69f71 | 11:1cb2279e3f30 |
---|---|
15 | 15 |
16 You can try it by appending a JID after <http://linkmauve.fr/avatar/>, | 16 You can try it by appending a JID after <http://linkmauve.fr/avatar/>, |
17 like: | 17 like: |
18 http://linkmauve.fr/avatar/linkmauve@linkmauve.fr | 18 http://linkmauve.fr/avatar/linkmauve@linkmauve.fr |
19 | 19 |
20 This program requiers the node.js framework, and either the xmpp.js | 20 This program requires the node.js framework, and either the xmpp.js |
21 library or node-xmpp. You can find these software here: | 21 library or node-xmpp. You can find these software here: |
22 http://nodejs.org/ | 22 http://nodejs.org/ |
23 http://xmppjs.prosody.im/ | 23 http://xmppjs.prosody.im/ |
24 https://github.com/astro/node-xmpp | 24 https://github.com/astro/node-xmpp |
25 | |
26 For example, if you are using npm, you can do: | |
27 npm install node-xmpp | |
28 npm install node-stringprep (it depends of libicu-dev on debian) | |
29 npm install ltx | |
25 | 30 |
26 Or if your distribution has these packaged (as in ArchLinux), simply | 31 Or if your distribution has these packaged (as in ArchLinux), simply |
27 install the packaged version. | 32 install the packaged version. |
28 | 33 |
29 An example of configuration file is provided in | 34 An example of configuration file is provided in |
30 configuration.js.example. You only have to rename it as | 35 configuration.js.example. You only have to rename it as |
31 configuration.js and modify it for your needs. All options should be | 36 configuration.js and modify it for your needs. All options should be |
32 enough documented; if not, contact me. | 37 enough documented; if not, contact me. |
33 | 38 |
34 When you have the dependances installed, you can simply run: | 39 When you have the dependencies installed, you can simply run: |
35 % ./avatar.js | 40 % ./avatar.js |
36 to launch the component. | 41 to launch the component. |
37 | 42 |
38 There is no install procedure for now. | 43 There is no install procedure for now. |
39 | 44 |