Permalink
Browse files

updates for github

  • Loading branch information...
1 parent 8ca1455 commit 6ed9140e733f1390d7c277578969020690e58202 @stevenbird stevenbird committed Jan 7, 2012
Showing with 32 additions and 84 deletions.
  1. +10 −10 Makefile
  2. +22 −74 RELEASE-HOWTO
View
@@ -32,15 +32,15 @@ usage:
all: dist
-upload:
- $(UPLOAD) --summary="NLTK $(VERSION) for Windows" dist/nltk-$(VERSION)*.win32.exe
- $(UPLOAD) --summary="NLTK $(VERSION) for Mac" dist/nltk-$(VERSION)*.dmg
- $(UPLOAD) --summary="NLTK $(VERSION) Source (zip)" dist/nltk-$(VERSION)*.zip
- $(UPLOAD) --summary="NLTK $(VERSION) Source (tgz)" dist/nltk-$(VERSION)*.tar.gz
-# $(UPLOAD) --summary="NLTK $(VERSION) RPM package" dist/nltk-$(VERSION)*.noarch.rpm
-# $(UPLOAD) --summary="NLTK $(VERSION) Debian package" dist/nltk_$(VERSION)-1_all.deb
- $(UPLOAD) --summary="NLTK $(VERSION) Egg" dist/nltk-$(VERSION)*.egg
- $(UPLOAD) --summary="NLTK-Contrib $(VERSION)" ../nltk_contrib/dist/nltk_contrib-$(VERSION)*.zip
+# upload:
+# $(UPLOAD) --summary="NLTK $(VERSION) for Windows" dist/nltk-$(VERSION)*.win32.exe
+# $(UPLOAD) --summary="NLTK $(VERSION) for Mac" dist/nltk-$(VERSION)*.dmg
+# $(UPLOAD) --summary="NLTK $(VERSION) Source (zip)" dist/nltk-$(VERSION)*.zip
+# $(UPLOAD) --summary="NLTK $(VERSION) Source (tgz)" dist/nltk-$(VERSION)*.tar.gz
+# # $(UPLOAD) --summary="NLTK $(VERSION) RPM package" dist/nltk-$(VERSION)*.noarch.rpm
+# # $(UPLOAD) --summary="NLTK $(VERSION) Debian package" dist/nltk_$(VERSION)-1_all.deb
+# $(UPLOAD) --summary="NLTK $(VERSION) Egg" dist/nltk-$(VERSION)*.egg
+# $(UPLOAD) --summary="NLTK-Contrib $(VERSION)" ../nltk_contrib/dist/nltk_contrib-$(VERSION)*.zip
########################################################################
@@ -79,7 +79,7 @@ nltk/nltk.jar: $(JAVA_SRC)
# DISTRIBUTIONS
########################################################################
-dist: zipdist gztardist rpmdist windist eggdist dmgdist
+dist: zipdist gztardist windist
gztardist: clean_code
$(PYTHON) setup.py -q sdist --format=gztar
View
@@ -2,43 +2,46 @@ Building an NLTK distribution
----------------------------------
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
-@@@ PREPARE
+@@@ BUILD
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
A. MISC PREPARATION
1. Check for new versions of Python, Numpy, Matplotlib, and update wiki download instructions
2. Update the data index (make data_index) and commit
3. Update the ChangeLog ("svn log; then summarize the key changes")
+ 4. Update the news page in nltk/web/news.rst
B. NLTK VERSION
- 1. Modify nltk/__init__.py with the version number (2 places)
- 2. Edit doc/definitions.rst with new version number
- 3. Edit NLTK.pmdoc with the new version number
- (cd trunk/nltk; open NLTK.pmdoc (starts PackageMaker)
- then click on the little triangle beside MacRoot to open it
- then select MacRoot / to highlight this
- then change the Install (source) directory
- then set the package version, and finally Menu:Edit:Save)
- 4. Commit these changes
- 5. Update version numbers, hyperlinks and anchors on the wiki download page
- (optionally create a cloned page download-M.N for the new version,
- and move it over the top of the standard one when its ready)
+ 1. Modify nltk/VERSION with the version number and commit
C. ERROR CHECKING
1. install the new version, since its the installed code that is checked
2. cd nltk/test; make (run the tests in nltk.test)
3. make demotest (run the demonstration code included in many modules)
- 4. API docs (cd doc; make api) (check latest version of epydoc is installed)
- 5. Book examples (cd doc/book; make errs)
- 6. Check issue tracker: http://code.google.com/p/nltk/issues/list
- 7. Make dist, install .exe version on Windows, and test demos
+ 4. API docs (cd web; make; cd ../../nltk.github.com; ...)
+ 5. Make dist
+ ?. (cd ../nltk_contrib; make dist???)
+
+D. UPLOAD
+
+ 1. sudo python setup.py register
+ 2. Log in to http://pypi.python.org/pypi and upload distributions
+ 3. post announcement to NLTK the mailing lists:
+ nltk-dev (for beta releases)
+ nltk (for final releases)
+ 4. post announcement to external mailing lists, for major N.N releases only
+ CORPORA@uib.no, linguist@linguistlist.org,
+ PythonSIL@lists.sil.org, edu-sig@python.org
+ mailing lists for any local courses using NLTK
+
+
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
-@@@ BUILD
+@@@ BOOK BUILD
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
The build requires docutils, pdflatex, python imaging library, epydoc,
@@ -47,66 +50,11 @@ The build requires docutils, pdflatex, python imaging library, epydoc,
1. Check out a clean copy of the subversion repository (or make clean)
and install locally with sudo python setup.py install; make clean
2. make doc (slow; see doc/ for the results) and commit
- 3. make dist (fast; see dist/ for the results; may need "sudo make dist")
- - remove source rpm since we don't distribute this
- - may need to build rpm on a different machine
- - S.Bethard can build .msi files
- (test the distributions?)
- 4. check file sizes are about the same as previously released files
- 5. (cd ../nltk_contrib; make dist)
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
-@@@ RELEASE
+@@@ INSTALL
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
-A. UPLOAD DISTRIBUTIONS
-
- 1. make upload (copies stuff up to Googlecode, including from nltk_contrib)
- 2. check result at http://code.google.com/p/nltk/downloads/list
- 3. if this is a non-beta release,
- change previous release to remove its "Featured" label
- (just click anywhere in the whitespace in its row to change its properties)
-
-B. PORTFILE
-
- - skip this for beta releases
-
- 0. Initial setup:
- Edit /opt/local/etc/macports/sources.conf, adding a pathname
- e.g. file:///Users/sb/ports before the default path
- It should be the same location used by the Makefile $LMACPORTS without /python
- 1. make macports
- 2. cd ~/ports; portindex
- 3. Test the Portfiles using, e.g. "port install py25-nltk" etc
- 4. Create a new ticket: https://trac.macports.org/newticket
- Log in using same username that is used for accessing the svn repository
- > Summary: py*-nltk: upgrade to $VERSION
- > Description: Updated port for NLTK (http://nltk.org/)
- > Type: update
- > Keywords: haspatch maintainer
- > version: [CLEAR THIS]
- > Port: py-nltk py25-nltk py26-nltk
- Then attach the diff files, nltk/dist/Portfile*.diff
-
-C. WEBSITE
-
- - for beta releases, skip this section, and post to nltk-dev only
-
- 1. install download page, by moving Download-N.N to Download
- 2. post a news item at http://nltk.org/news-archive, summary at http://nltk.org/
- 3. register with Python Cheeseshop: make pypi
- (make sure that just the source .tar.gz file was uploaded (no macosx file)
- (make sure that the .tar.gz file contains the version of setup.py with
- a pyyaml dependency)
- 4. sync the book to the website (cd doc; make publish)
- 5. post announcement to NLTK the mailing lists:
- nltk-dev (for beta releases)
- nltk (for final releases)
- 6. post announcement to external mailing lists, for major N.N releases only
- CORPORA@uib.no, linguist@linguistlist.org,
- PythonSIL@lists.sil.org, edu-sig@python.org
- mailing lists for any local courses using NLTK
-
D. INSTALLATION
1. download and install new version on all machines

0 comments on commit 6ed9140

Please sign in to comment.