* mixi-el: Version 1.4.1 released.
[elisp/mixi.git] / README
1 What's this?
2 ------------
3
4   mixi.el is API libraries for accessing to mixi for Emacs.
5
6 Features
7 --------
8
9   * You can get the following data on mixi:
10
11     - Friends
12     - Favorites
13     - Logs
14     - Diaries
15     - Communities
16     - BBSes
17     - Comments
18     - Messages
19     - Introductions
20     - News
21     - Releases
22
23   * You can post the following data to mixi:
24
25     - Diary
26     - Topic
27     - Comment
28     - Message
29
30 Working Environments
31 --------------------
32
33   The latest version of mixi.el is verified to work properly under
34   following emacsen.
35
36   Emacs 22.1
37   Emacs 22.1.50
38
39 Requirements
40 ------------
41
42   You need one of following packages:
43
44     * emacs-w3m  - http://emacs-w3m.namazu.org/
45     * url.el     - included in your Emacs
46     * cURL       - http://curl.haxx.se/
47
48 Installation
49 ------------
50
51   % ./configure
52   % make
53   % su
54   # make install
55
56 How to use
57 ----------
58
59 Info manual is available after installation.  To read, start Emacs and
60 type `M-x info' and select "mixi-ja" (Japanese only).
61
62 Copying
63 -------
64
65   mixi-el is copyrighted free software by OHASHI Akira <bg66@koka-in.org>.
66   You can redistribute it and/or modify it under either the terms of
67   the GPL (see the file `COPYING').
68
69 Information
70 -----------
71
72   For more information, see the mixi-el community on mixi.
73
74     <URL:http://mixi.jp/view_community.pl?id=1596390>
75
76 Development
77 -----------
78
79   Development of mixi-el uses CVS, Concurrent Versions System.  Latest
80   development version is available via CVS.
81
82   * cvs login (first time only)
83
84     % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login
85     (CVS password: [CR] # NULL string)
86
87   * checkout modules
88
89     % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout mixi
90  
91   Browsing the CVS tree gives you a great view into the current status
92   of this project's code.  You may also view the complete history of
93   any file in the repository.
94   Please refer to <URL:http://cvs.m17n.org/cgi-bin/viewcvs/mixi/>.
95
96   If you would like to join CVS based development, please refer to
97   <URL:http://cvs.m17n.org/>.
98
99 Bug reports
100 -----------
101
102   If you have bug reports and/or suggestions for improvement, please
103   send them via <URL:http://mixi.jp/view_community.pl?id=1596390>.