Updated README to better align with GNU coding standards

svn path=/trunk/; revision=832
This commit is contained in:
Curtis Gedak 2008-04-25 15:51:08 +00:00
parent 59ff838bfd
commit b6ce298c18
2 changed files with 62 additions and 51 deletions

View File

@ -1,3 +1,8 @@
2008-04-25 Curtis Gedak <gedakc@gmail.com>
* README: Updated to better align with GNU coding standards
- Closes GParted bug 529625
2008-04-23 Curtis Gedak <gedakc@gmail.com>
* README: Updated installation notes and distribution notes

108
README
View File

@ -1,68 +1,79 @@
GPARTED
-------
Gparted is the Gnome Partition Editor for creating, reorganizing, and
deleting disk partitions.
GParted stands for Gnome Partition Editor.
A hard disk is usually subdivided into one or more partitions. These
partitions are normally not re-sizable (making one smaller and the
adjacent one larger.) Gparted makes it possible for you to take a
hard disk and change the partition organization, while preserving the
partition contents.
It uses libparted to detect and manipulate devices and partition
tables while several (optional) file system tools provide support for
file systems not included in libparted. These optional packages will
be detected at runtime and don't require a rebuild of GParted.
More specifically, Gparted enables you to create, destroy, resize,
move, check, label, and copy partitions, and the file systems
contained within. This is useful for creating space for new operating
systems, reorganizing disk usage, and mirroring one partition with
another (disk imaging).
GParted is written in C++ and uses gtkmm as Graphical Toolkit. The
general approach is to keep the GUI as simple as possible. That's why
we try to conform to the GNOME Human Interface Guidelines.
Gparted uses GNU libparted to detect and manipulate devices and
partition tables. Several optional packages provide additional file
system support. Optional packages include:
e2fsprogs, dosfstools, mtools, hfsutils, jfsutils,
ntfsprogs, reiser4progs, reiserfsprogs, and xfsprogs.
Visit http://gparted.sourceforge.net for more information
Gparted can also be used with storage devices other than hard disks,
such as USB flash drives, and memory cards.
Visit http://gparted.sourceforge.net for more information.
INSTALL NOTES
-------------
Compiling GParted requires that several dependencies are installed.
Following are instructions on how to install these dependencies (which
may install other dependencies) on two different GNU/Linux
distributions:
(k)ubuntu 7.10 Gutsy Gibbon
---------------------------
sudo apt-get install build-essential e2fsprogs uuid uuid-dev \
gnome-common libparted-dev libgtkmm-2.4-dev
NEWS
----
Information about changes to this release, and past releases can be
found in the file:
NEWS
Fedora 8
--------
su -
yum groupinstall "Development Tools"
yum install perl-XML-DOM.noarch e2fsprogs-devel parted-devel \
gnome-common gtkmm24-devel
INSTALL
-------
Installation instructions can be found in the file:
INSTALL
Compiling and installing GParted is performed using the standard
steps of:
./configure
make
make install
COPYING
-------
The copying conditions can be found in the file:
COPYING
For more information on installation instructions, refer to the
file named INSTALL.
DIRECTORIES
------------
compose - contains String::ucompose() function
doc - contains manual page documentation
include - contains source header files
pixmaps - contains desktop icon
po - contains international language translations
src - contains C++ source code
DISTRIBUTION NOTES
------------------
The following notes are intended to assist GNU/Linux distribution
packagers. More information on GParted features can be found at:
http://gparted.sourceforge.net/features.php
GParted uses GNU libparted to detect and manipulate devices and
partition tables.
Several optional packages provide additional file system support.
Optional packages that should be listed include:
GParted Dependencies:
libparted
libuuid
libdl
libgtkmm
Optional (suggested) packages:
e2fsprogs
dosfstools
mtools
@ -72,10 +83,5 @@ Optional packages that should be listed include:
reiser4progs
reiserfsprogs
xfsprogs
If the vol_id command is in the search PATH, it will be used to read
linux-swap volume labels.
Note to packagers: The above optional packages are not mandatory for
gparted operation, and should probably listed
as 'suggests' not 'depends on'.
NOTE: If the vol_id command is in the search PATH, it will be
used to read linux-swap volume labels.