Reorder the README files.

Delete README_DIST.
Use README as the readme file for the distribution.
Use README_ELPA as the readme file for ELPA packages.
New README_git file to describe readme files in git.
Update mk/server.mk to include the correct READMEs.
Update mk/set-version.pl to update README.
Add some more help info in mk/server.mk.
This commit is contained in:
Bastien Guerry 2012-09-21 16:35:04 +02:00
parent 1aa21dc70d
commit ae57da7d80
5 changed files with 92 additions and 45 deletions

31
README
View File

@ -1,4 +1,7 @@
This is the Emacs Org project, an Emacs library for organizing your life.
The is a distribution of Org, a plain text notes and project planning
tool for Emacs.
The version of this release is: 7.9.1
The homepage of Org is at http://orgmode.org
@ -7,24 +10,11 @@ This distribution contains:
README
This file.
README_DIST
The README file for the distribution (zip and tar files)
README_contribute
Information about the git repository and how to contribute
to Org-mode development.
README_maintainer
Information for the maintainer.
Makefile
The makefile to compile and install Org. For installation
instructions, see the manual or the more detailed procedure
on Worg: http://orgmode.org/worg/dev/org-build-system.html
mk/
Files needed for building Org.
lisp/
Directory with all the Emacs Lisp files that make up Org.
@ -32,18 +22,21 @@ doc/
The documentation files. org.texi is the source of the
documentation, org.html and org.pdf are formatted versions of it.
etc/
Files needed for the ODT exporter.
contrib/
A directory with third-party additions for Org. Some really cool
stuff is in there.
etc/
Files needed for the ODT exporter.
mk/
Files needed for building Org.
testing/
Testing suite for Org.
request-assign-future.txt
The form that contributors have to sign and get processed with the
FSF before contributed changes can be integrated into the Org
The form that contributors have to sign and get processed with
the FSF before contributed changes can be integrated into the Org
core. All files in this distribution except the contrib/ directory
have copyright assigned to the FSF.

37
README_ELPA Normal file
View File

@ -0,0 +1,37 @@
This is the Emacs Org project, an Emacs library for organizing your life.
The homepage of Org is at http://orgmode.org
This distribution contains an ELPA packaged version of Org.
"ELPA" stands for the "Emacs Lisp Package Archive".
The GNU ELPA is here:
http://elpa.gnu.org
It contains the org-*.tar package, containing only the org files
that are also part of GNU Emacs.
There are other ELPA online, offering more packages.
Some contain the org-plus-contrib-*.tar ELPA package, which bundles
the core Org files plus many additional contributed libraries.
All ELPA version of Org contain:
README_ELPA
This file.
*el
Elisp files.
org
The Org info manual.
orgcard.pdf
The Org reference card.
etc/
Libraries for the ODT exporter.
org-*-pkg.el
The name of the package, requested GNU Emacs packaging system.

View File

@ -1,20 +1,33 @@
The is a distribution of Org, a plain text notes and project planning
tool for Emacs.
The version of this release is: 7.9
This is the Emacs Org project, an Emacs library for organizing your life.
The homepage of Org is at http://orgmode.org
This distribution contains:
README
README_git
This file.
README
The README file for the main distribution (zip and tar files).
README_ELPA
The README file for the ELPA packages.
README_contribute
Information about the git repository and how to contribute
to Org-mode development.
README_maintainer
Information for the maintainer.
Makefile
The makefile to compile and install Org. For installation
instructions, see the manual or the more detailed procedure
on Worg: http://orgmode.org/worg/dev/org-build-system.html
mk/
Files needed for building Org.
lisp/
Directory with all the Emacs Lisp files that make up Org.
@ -22,21 +35,18 @@ doc/
The documentation files. org.texi is the source of the
documentation, org.html and org.pdf are formatted versions of it.
contrib/
A directory with third-party additions for Org. Some really cool
stuff is in there.
etc/
Files needed for the ODT exporter.
mk/
Files needed for building Org.
contrib/
A directory with third-party additions for Org. Some really cool
stuff is in there.
testing/
Testing suite for Org.
request-assign-future.txt
The form that contributors have to sign and get processed with
the FSF before contributed changes can be integrated into the Org
The form that contributors have to sign and get processed with the
FSF before contributed changes can be integrated into the Org
core. All files in this distribution except the contrib/ directory
have copyright assigned to the FSF.

View File

@ -13,9 +13,11 @@ help helpall helpserver::
$(info Maintenance)
$(info ===========)
$(info release - clean up, create the distribution archives)
$(info elpa - clean up, create the ELPA archive)
$(info elpa - clean up, create the org-*.tar ELPA archive)
$(info elpaplus - clean up, create the org-plus-contrib-*.tar ELPA archive)
$(info upload-release - clean up, populate the server with arhives)
$(info upload-elpa - clean up, populate the server with ELPA)
$(info upload-elpa - clean up, populate the server with org-*.tar)
$(info upload-elpaplus - clean up, populate the server with org-plus-contrib-*.tar)
$(info upload-doc - clean up, populate the server with docs)
$(info upload - clean up, populate the server with everything)
@ -29,15 +31,20 @@ SERVERMK ?= true # or just any value at all, really
#----------------------------------------------------------------------
ORGCOMM = README lisp/
ORGFULL = $(ORGCOMM) Makefile request-assign-future.txt \
mk/default.mk mk/targets.mk mk/version.mk \
mk/org-fixup.el \
etc/ contrib/ doc/
ORGFULL := $(ORGFULL:%/=%/*)
ORGELPA = $(ORGCOMM) doc/dir doc/org doc/orgcard.pdf \
etc/styles/ org-pkg.el
ORGELPA := $(ORGELPA:%/=%/*)
ORGREADMECOMM = README
ORGREADMEELPA = README_ELPA
ORGCOMM = lisp/
ORGFULL = $(ORGCOMM) $(ORGREADMECOMM) \
Makefile request-assign-future.txt \
mk/default.mk mk/targets.mk mk/version.mk \
mk/org-fixup.el \
etc/ contrib/ doc/
ORGFULL := $(ORGFULL:%/=%/*)
ORGELPA = $(ORGCOMM) $(ORGREADMEELPA) \
doc/dir doc/org doc/orgcard.pdf \
etc/styles/ org-pkg.el
ORGELPA := $(ORGELPA:%/=%/*)
ORGELPAPLUS := $(ORGELPA:org-pkg%=org-plus-contrib-pkg%)
release: cleanall info pdf card rel-dirty tagwarn

View File

@ -38,8 +38,8 @@ if (not $only) {
$c1 = "perl -pi -e '$cmd' doc/orgcard.tex";
system($c1);
print STDERR "README_DIST\n";
print STDERR "README\n";
$cmd = qq{s/^(The version of this release is:)\\s+(\\S+)[ \t]*\$/\$1 $version/;};
$c1 = "perl -pi -e '$cmd' README_DIST";
$c1 = "perl -pi -e '$cmd' README";
system($c1);
}