lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Chris Hostetter <hossman_luc...@fucit.org>
Subject Re: top-level README or similar?
Date Tue, 04 Jan 2011 23:06:30 GMT

+1

(FWIW: i didn't notice until now that those IDE targets get added, might 
be nice to standardize on a naming convention... "ant setup-ide-idea", 
"ant setup-ide-ecplise", etc...)

: Date: Tue, 4 Jan 2011 08:05:22 -0500
: From: Robert Muir <rcmuir@gmail.com>
: Reply-To: dev@lucene.apache.org
: To: dev@lucene.apache.org
: Subject: top-level README or similar?
: 
: Hello,
: 
: I noticed in our top-level trunk folder, it looks like this:
: * build.xml
: * dev-tools
: * lucene
: * modules
: * solr
: 
: Perhaps we should add a very basic README.txt to get people started?
: I noticed other projects seem to have something like this.
: 
: I was thinking something like:
: 
: lucene/ is a search engine library
: solr/ is a search engine server that uses lucene
: modules/ is shared code
: 
: To compile the sources run 'ant compile'
: To run all the tests run 'ant test'
: To setup your ide run 'ant copy-idea-files' (for Intellij) or 'ant
: eclipse' (for eclipse)
: 
: For more information on how to contribute see <wiki link>
: 
: ---------------------------------------------------------------------
: To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
: For additional commands, e-mail: dev-help@lucene.apache.org
: 

-Hoss

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message