First round of documentation updates.
authorgregor herrmann <gregoa@debian.org>
Thu, 23 Jun 2011 15:26:24 +0000 (15:26 +0000)
committergregor herrmann <gregoa@debian.org>
Thu, 23 Jun 2011 15:26:24 +0000 (15:26 +0000)
12 files changed:
AUTHORS
INSTALL
NEWS
README
TODO
docs/fosdem-schedule/AUTHORS [new file with mode: 0644]
docs/fosdem-schedule/Changelog [new file with mode: 0644]
docs/fosdem-schedule/INSTALL [new file with mode: 0644]
docs/fosdem-schedule/NEWS [new file with mode: 0644]
docs/fosdem-schedule/README [new file with mode: 0644]
docs/fosdem-schedule/user-stories.txt [new file with mode: 0644]
docs/user-stories.txt [deleted file]

diff --git a/AUTHORS b/AUTHORS
index 52bcafd..1b8dba2 100644 (file)
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,10 +1,5 @@
-Authors of fosdem-schedule.
-
-  Copyright (C) 2010 Ixonos Plc. 
-
-  Copying and distribution of this file, with or without modification,
-  are permitted in any medium without royalty provided the copyright
-  notice and this notice are preserved.
+This is the AUTHORS file for ConfClerk. ConfClerk is the successor of
+fosdem-schedule; cf. docs/fosdem-schedule for the historic documentation.
 
 Francisco Fortes 
 Matus Hanzes 
@@ -15,25 +10,5 @@ Monika Berendova
 Pavol Korinek
 Pavol Pavelka
 Maksim Kirillov
-
-Files add.png, reload.png, remove.png in  src/icons/ directory
-are taken from Ubuntu package gnome-icon-theme. Copyright notice
-for them copied here:
-
-> This package was debianized by Takuo KITAME <kitame@debian.org> on
-> Fri, 17 Jan 2003 14:57:28 +0900.
-> 
-> It was downloaded from <http://download.gnome.org/sources/gnome-icon-theme/>
-> 
-> Copyright © 2002-2008:
->    Ulisse Perusin <uli.peru@gmail.com>
->    Riccardo Buzzotta <raozuzu@yahoo.it>
->    Josef Vybíral <cornelius@vybiral.info>
->    Hylke Bons <h.bons@student.rug.nl>
->    Ricardo González <rick@jinlabs.com>
->    Lapo Calamandrei <calamandrei@gmail.com>
->    Rodney Dawes <dobey@novell.com>
->    Luca Ferretti <elle.uca@libero.it>
->    Tuomas Kuosmanen <tigert@gimp.org>
->    Andreas Nilsson <nisses.mail@home.se>
->    Jakub Steiner <jimmac@novell.com>
+Philipp Spitzer
+gregor herrmann
diff --git a/INSTALL b/INSTALL
index e32aa70..d6da4f4 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,39 +1,16 @@
-This is the INSTALL file for the fosdem-schedule distribution.
+This is the INSTALL file for ConfClerk. ConfClerk is the successor of
+fosdem-schedule; cf. docs/fosdem-schedule for the historic documentation.
 
-  Copyright (C) 2010 Ixonos Plc. 
 
-  Copying and distribution of this file, with or without modification,
-  are permitted in any medium without royalty provided the copyright
-  notice and this notice are preserved.
+Note
 
-NOTE
-====
+ConfClerk is an application intended for mobile devices like the Nokia N810 and N900.
+The preferred distribution is using a packaged version for your distribution.
 
-fosdem-schedule is an application intended for Nokia N810 and N900 Internet
-tablet devices.  Therefor the preferred distribution is a Debian package.
-Notice the different release of the Maemo platform on each of the devices,
-which requires a specific Debian package.  
-
-Maemo is a trademark of Nokia Corporation.  Debian is a registered trademark
-owned by SPI in the United States, and managed by the debian project, as
-explained on their site.
 
 Basic Installation
-==================
 
 1. Type `qmake' to generate Makefiles.
 2. Type `make' to compile the source code.
 3. Type `make install' to install the executable.  
 4. Type `make uninstall' to remove all installed files form your system.      
-
-Maemo Package Building 
-======================
-
-1. Type `qmake' to generate Makefiles.
-2. Check the "Build-Depends" section of the control file for required packages.
-   Maemo 3 (Diablo) specific:
-   - Ignore the version strings when building a package for Maemo 3 (Diablo).
-   - Optification of the package is not explicitly required, to disable it
-     comment out the "maemo-optify $(PKG_NAME)" line in debian/rules.  
-3. Type `dpkg-buildpackage -rfakeroot -b -uc' to build a package.  
\ No newline at end of file
diff --git a/NEWS b/NEWS
index fdaab92..c41e35f 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,19 +1,7 @@
+This is the NEWS file for ConfClerk. ConfClerk is the successor of
+fosdem-schedule; cf. docs/fosdem-schedule for the historic documentation.
 
-This NEWS file records noteworthy changes, very tersely.
+Version 0.5
+* 
 
-Version 0.3 (3 Feb 2010)
-* Performance improvement for events. 
-
-Version 0.2 (2 Feb 2010)
-* Search tab has been added.
-* Alarms handled by alarmd, which requests native alarm dialogs (N900 only).
-* A service is registered to DBus, the application is handling calls from alarm
-  dialogs to reflect alarm states into the database.  The application is
-  started if required (N900 only).
-
-Version 0.1 (19 Jan 2010) 
-* A user can select favourite events, which are displayed in "Favourites" tab.
-* FOSDEM icon is displayed in application manager and in applications menu.        
-* Optification of the package is done using maemo-optify script.
-* There is now a `NEWS' file (this one), giving a history of
-  user-visible changes.
+//! TODO
diff --git a/README b/README
index f8f46f8..f149a6e 100644 (file)
--- a/README
+++ b/README
@@ -1,52 +1,84 @@
-This is the README file for the fosdem-schedule distribution.  
+This is the README file for ConfClerk. ConfClerk is the successor of
+fosdem-schedule; cf. docs/fosdem-schedule for the historic documentation.
 
-  Copyright (C) 2010 Ixonos Plc. 
 
-  Copying and distribution of this file, with or without modification,
-  are permitted in any medium without royalty provided the copyright
-  notice and this notice are preserved.
+Description:
 
-fosdem-schedule is an application written in Qt, which makes the FOSDEM
-conference schedule available offline.  It displays the conference schedule
+ConfClerk is an application written in Qt, which makes conference
+schedules available offline.  It displays the conference schedule
 from various views, support searches on various items (speaker, speech topic,
 location, etc.) and enables you to select favorite events and create your own
-schedule.  For Nokia N810 and N900.
+schedule.
 
-See the file ./INSTALL for building and installation instructions.
+At the moment ConfClerk is able to import schedules in XML format created by
+the PentaBarf conference management system used by e.g. FOSDEM, DebConf, and
+the CCC.
 
-Primary distribution point: http://sourceforge.net/projects/fosdem-maemo/
+ConfClerk is targetted at mobile devices like the Nokia N810 and N900 but
+works on any sytem running Qt.
 
-Home page: http://sourceforge.net/apps/mediawiki/fosdem-maemo/
+See the file ./INSTALL for building and installation instructions, and
+./AUTHORS for the list of contributors.
 
-Mailing list: fosdem-maemo-devel@lists.sourceforge.net
-- please use this list for all discussion: bug reports, enhancements, etc.
-- archived at: http://sourceforge.net/mailarchive/forum.php?forum_name=fosdem-maemo-devel
-- anyone is welcome to join the list; to do so, visit
-  https://lists.sourceforge.net/lists/listinfo/fosdem-maemo-devel
 
-Bug reports:
- Please include enough information for the maintainers to reproduce the
- problem.  Generally speaking, that means:
-- the contents of any input files necessary to reproduce the bug
-  and command line invocations of the program(s) involved (crucial!).
-- a description of the problem and any samples of the erroneous output.
-- the version number of the program(s) involved (use --version).
-- hardware, operating system, and compiler versions (uname -a).
-- anything else that you think would be helpful.
+Copyright and License:
 
-Patches are most welcome; if possible, please make them with diff -c and
-include ChangeLog entries.
+  Copyright (C) 2010 Ixonos Plc.
+  Copyright (C) 2011, Philipp Spitzer, gregor herrmann
 
-fosdem-schedule is free software.  See the file COPYING for copying conditions.
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
 
-About FOSDEM 2010:
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
 
-The tenth FOSDEM is a two-day event organized by volunteers to promote the
-widespread use of Free and Open Source software.  Taking place in the beautiful
-city of Brussels (Belgium), FOSDEM meetings are recognized as "The best Free
-Software and Open Source events in Europe".
+  You should have received a copy of the GNU General Public License along
+  with this program; if not, write to the Free Software Foundation, Inc.,
+  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
-FOSDEM name and FOSDEM brain icon are Trademarks of FOSDEM ASBL, which gave
-this project the rights to use the brain icon and name.  Copying and
-distribution of the FOSDEM brain icon must follow the Creative Commons
-Attribution-Noncommercial-No Derivative Works 2.0 Belgium License.
\ No newline at end of file
+
+//! TODO
+
+Files add.png, reload.png, remove.png in  src/icons/ directory
+are taken from Ubuntu package gnome-icon-theme. Copyright notice
+for them copied here:
+
+> This package was debianized by Takuo KITAME <kitame@debian.org> on
+> Fri, 17 Jan 2003 14:57:28 +0900.
+> 
+> It was downloaded from <http://download.gnome.org/sources/gnome-icon-theme/>
+> 
+> Copyright © 2002-2008:
+>    Ulisse Perusin <uli.peru@gmail.com>
+>    Riccardo Buzzotta <raozuzu@yahoo.it>
+>    Josef Vybíral <cornelius@vybiral.info>
+>    Hylke Bons <h.bons@student.rug.nl>
+>    Ricardo González <rick@jinlabs.com>
+>    Lapo Calamandrei <calamandrei@gmail.com>
+>    Rodney Dawes <dobey@novell.com>
+>    Luca Ferretti <elle.uca@libero.it>
+>    Tuomas Kuosmanen <tigert@gimp.org>
+>    Andreas Nilsson <nisses.mail@home.se>
+>    Jakub Steiner <jimmac@novell.com>
+
+
+
+History:
+
+ConfClerk started as fosdem-schedule, targetted at Maemo as an operating
+system and the FOSDEM conference.
+fosdem-schedule was written by Ixonos Plc., maintained at
+http://sourceforge.net/projects/fosdem-maemo/ , and released under the GNU GPL
+2 or later.
+Cf. docs/fosdem-schedule for more information.
+
+ConfClerk is the successor of fosdem-schedule, aiming at improvements and
+generalization regarding supported platforms and conference systems.
+The project was started after fosdem-schedule was not actively developped
+anymore and with the "blessing" of the fosdem-schedule developers; cf.
+http://sourceforge.net/mailarchive/forum.php?thread_name=20110621171440.GA4521%40nerys.comodo.priv.at&forum_name=fosdem-maemo-devel
+Thanks guys!
diff --git a/TODO b/TODO
index 5f6b190..b0027e4 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,10 +1,5 @@
 fosdem-schedule -> confclerk transition:
-- Files:
-  + AUTHORS
-  + INSTALL
-  + README
 - (c) in the code
-- add history somewhere
 - rename *.pro, s/fosdem-schedule/confclerk/ in various places
 - .sqlite file location, config location
 
@@ -20,8 +15,6 @@ maemo:
 - rm debian
 
 other
-- continue NEWS
 - ChangeLog -> svn2cl
-- docs/user-stories.txt is interesting but do we need doc/?
 - copyright for icons / replace icons (gnome-icon-theme etc.)
 - add release target to .pro; and VERSION
diff --git a/docs/fosdem-schedule/AUTHORS b/docs/fosdem-schedule/AUTHORS
new file mode 100644 (file)
index 0000000..52bcafd
--- /dev/null
@@ -0,0 +1,39 @@
+Authors of fosdem-schedule.
+
+  Copyright (C) 2010 Ixonos Plc. 
+
+  Copying and distribution of this file, with or without modification,
+  are permitted in any medium without royalty provided the copyright
+  notice and this notice are preserved.
+
+Francisco Fortes 
+Matus Hanzes 
+Martin Komara
+Marek Timko
+Matus Uzak
+Monika Berendova
+Pavol Korinek
+Pavol Pavelka
+Maksim Kirillov
+
+Files add.png, reload.png, remove.png in  src/icons/ directory
+are taken from Ubuntu package gnome-icon-theme. Copyright notice
+for them copied here:
+
+> This package was debianized by Takuo KITAME <kitame@debian.org> on
+> Fri, 17 Jan 2003 14:57:28 +0900.
+> 
+> It was downloaded from <http://download.gnome.org/sources/gnome-icon-theme/>
+> 
+> Copyright © 2002-2008:
+>    Ulisse Perusin <uli.peru@gmail.com>
+>    Riccardo Buzzotta <raozuzu@yahoo.it>
+>    Josef Vybíral <cornelius@vybiral.info>
+>    Hylke Bons <h.bons@student.rug.nl>
+>    Ricardo González <rick@jinlabs.com>
+>    Lapo Calamandrei <calamandrei@gmail.com>
+>    Rodney Dawes <dobey@novell.com>
+>    Luca Ferretti <elle.uca@libero.it>
+>    Tuomas Kuosmanen <tigert@gimp.org>
+>    Andreas Nilsson <nisses.mail@home.se>
+>    Jakub Steiner <jimmac@novell.com>
diff --git a/docs/fosdem-schedule/Changelog b/docs/fosdem-schedule/Changelog
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/docs/fosdem-schedule/INSTALL b/docs/fosdem-schedule/INSTALL
new file mode 100644 (file)
index 0000000..e32aa70
--- /dev/null
@@ -0,0 +1,39 @@
+This is the INSTALL file for the fosdem-schedule distribution.
+
+  Copyright (C) 2010 Ixonos Plc. 
+
+  Copying and distribution of this file, with or without modification,
+  are permitted in any medium without royalty provided the copyright
+  notice and this notice are preserved.
+
+NOTE
+====
+
+fosdem-schedule is an application intended for Nokia N810 and N900 Internet
+tablet devices.  Therefor the preferred distribution is a Debian package.
+Notice the different release of the Maemo platform on each of the devices,
+which requires a specific Debian package.  
+
+Maemo is a trademark of Nokia Corporation.  Debian is a registered trademark
+owned by SPI in the United States, and managed by the debian project, as
+explained on their site.
+
+Basic Installation
+==================
+
+1. Type `qmake' to generate Makefiles.
+2. Type `make' to compile the source code.
+3. Type `make install' to install the executable.  
+4. Type `make uninstall' to remove all installed files form your system.      
+
+Maemo Package Building 
+======================
+
+1. Type `qmake' to generate Makefiles.
+2. Check the "Build-Depends" section of the control file for required packages.
+   Maemo 3 (Diablo) specific:
+   - Ignore the version strings when building a package for Maemo 3 (Diablo).
+   - Optification of the package is not explicitly required, to disable it
+     comment out the "maemo-optify $(PKG_NAME)" line in debian/rules.  
+3. Type `dpkg-buildpackage -rfakeroot -b -uc' to build a package.  
\ No newline at end of file
diff --git a/docs/fosdem-schedule/NEWS b/docs/fosdem-schedule/NEWS
new file mode 100644 (file)
index 0000000..fdaab92
--- /dev/null
@@ -0,0 +1,19 @@
+
+This NEWS file records noteworthy changes, very tersely.
+
+Version 0.3 (3 Feb 2010)
+* Performance improvement for events. 
+
+Version 0.2 (2 Feb 2010)
+* Search tab has been added.
+* Alarms handled by alarmd, which requests native alarm dialogs (N900 only).
+* A service is registered to DBus, the application is handling calls from alarm
+  dialogs to reflect alarm states into the database.  The application is
+  started if required (N900 only).
+
+Version 0.1 (19 Jan 2010) 
+* A user can select favourite events, which are displayed in "Favourites" tab.
+* FOSDEM icon is displayed in application manager and in applications menu.        
+* Optification of the package is done using maemo-optify script.
+* There is now a `NEWS' file (this one), giving a history of
+  user-visible changes.
diff --git a/docs/fosdem-schedule/README b/docs/fosdem-schedule/README
new file mode 100644 (file)
index 0000000..f8f46f8
--- /dev/null
@@ -0,0 +1,52 @@
+This is the README file for the fosdem-schedule distribution.  
+
+  Copyright (C) 2010 Ixonos Plc. 
+
+  Copying and distribution of this file, with or without modification,
+  are permitted in any medium without royalty provided the copyright
+  notice and this notice are preserved.
+
+fosdem-schedule is an application written in Qt, which makes the FOSDEM
+conference schedule available offline.  It displays the conference schedule
+from various views, support searches on various items (speaker, speech topic,
+location, etc.) and enables you to select favorite events and create your own
+schedule.  For Nokia N810 and N900.
+
+See the file ./INSTALL for building and installation instructions.
+
+Primary distribution point: http://sourceforge.net/projects/fosdem-maemo/
+
+Home page: http://sourceforge.net/apps/mediawiki/fosdem-maemo/
+
+Mailing list: fosdem-maemo-devel@lists.sourceforge.net
+- please use this list for all discussion: bug reports, enhancements, etc.
+- archived at: http://sourceforge.net/mailarchive/forum.php?forum_name=fosdem-maemo-devel
+- anyone is welcome to join the list; to do so, visit
+  https://lists.sourceforge.net/lists/listinfo/fosdem-maemo-devel
+
+Bug reports:
+ Please include enough information for the maintainers to reproduce the
+ problem.  Generally speaking, that means:
+- the contents of any input files necessary to reproduce the bug
+  and command line invocations of the program(s) involved (crucial!).
+- a description of the problem and any samples of the erroneous output.
+- the version number of the program(s) involved (use --version).
+- hardware, operating system, and compiler versions (uname -a).
+- anything else that you think would be helpful.
+
+Patches are most welcome; if possible, please make them with diff -c and
+include ChangeLog entries.
+
+fosdem-schedule is free software.  See the file COPYING for copying conditions.
+
+About FOSDEM 2010:
+
+The tenth FOSDEM is a two-day event organized by volunteers to promote the
+widespread use of Free and Open Source software.  Taking place in the beautiful
+city of Brussels (Belgium), FOSDEM meetings are recognized as "The best Free
+Software and Open Source events in Europe".
+
+FOSDEM name and FOSDEM brain icon are Trademarks of FOSDEM ASBL, which gave
+this project the rights to use the brain icon and name.  Copying and
+distribution of the FOSDEM brain icon must follow the Creative Commons
+Attribution-Noncommercial-No Derivative Works 2.0 Belgium License.
\ No newline at end of file
diff --git a/docs/fosdem-schedule/user-stories.txt b/docs/fosdem-schedule/user-stories.txt
new file mode 100644 (file)
index 0000000..847366b
--- /dev/null
@@ -0,0 +1,22 @@
+\r
+As an user I would like to have following features available in FOSDEM application:\r
+o   I\92d like to see all events for current day (default: current time)\r
+o   I\92d like to see all events for other days \r
+o   I\92d like to see all events grouped by activity\r
+o   I\92d like to see all events grouped by room\r
+o   I\92d like to see all details about selected event\r
+o   In detail view, I\92d like to have option  to show room on the map\r
+o   If there are some links in the event detail, I\92d like to have option to open link in browser\r
+o   In detail view, I\92d like to add/remove event to/from favorites\r
+o   I\92d like to search events by title/abstract, speaker name, tags, activity category, room number/name\r
+o   I\92d like to see my favorite events\r
+o   I\92d like to be noticed when some of my favorite events are overlapping\r
+o   I\92d like to add reminder into calendar for selected event\r
+o   I\92d like to see which events are added to calendar or to favorites\r
+o   I\92d like to option to update list of events through the web \r
+--------------------------------------------------------------------\r
+o   I'd like to have "my track" -- the personal schedule of events the user would like to attend.\r
+o   I wish to have "now button" to show me what's ongoing now.\r
+====================================================================\r
+o   I'd like to have possibility to post to eg. twitter or facebook -- some button to easy post on twitter "I'm attending now this". \r
+\r
diff --git a/docs/user-stories.txt b/docs/user-stories.txt
deleted file mode 100644 (file)
index 847366b..0000000
+++ /dev/null
@@ -1,22 +0,0 @@
-\r
-As an user I would like to have following features available in FOSDEM application:\r
-o   I\92d like to see all events for current day (default: current time)\r
-o   I\92d like to see all events for other days \r
-o   I\92d like to see all events grouped by activity\r
-o   I\92d like to see all events grouped by room\r
-o   I\92d like to see all details about selected event\r
-o   In detail view, I\92d like to have option  to show room on the map\r
-o   If there are some links in the event detail, I\92d like to have option to open link in browser\r
-o   In detail view, I\92d like to add/remove event to/from favorites\r
-o   I\92d like to search events by title/abstract, speaker name, tags, activity category, room number/name\r
-o   I\92d like to see my favorite events\r
-o   I\92d like to be noticed when some of my favorite events are overlapping\r
-o   I\92d like to add reminder into calendar for selected event\r
-o   I\92d like to see which events are added to calendar or to favorites\r
-o   I\92d like to option to update list of events through the web \r
---------------------------------------------------------------------\r
-o   I'd like to have "my track" -- the personal schedule of events the user would like to attend.\r
-o   I wish to have "now button" to show me what's ongoing now.\r
-====================================================================\r
-o   I'd like to have possibility to post to eg. twitter or facebook -- some button to easy post on twitter "I'm attending now this". \r
-\r