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