integer-net / solr-magento1

Free Solr Module for Magento 1 for greatly improved search results
GNU Lesser General Public License v3.0
48 stars 12 forks source link

Installation instructions could be improved #14

Open schmengler opened 7 years ago

schmengler commented 7 years ago

Step 5 of the installation instructions currently reads

If using Composer: Just add "integer-net/solr-magento1" to the list of requirements in your composer.json. Otherwise: Download the archive from the Releases Page. Copy the files and directories from the src directory of the module repository into your Magento installation. Attention: You will need the files of two more repositories: The IntegerNet_Solr base library and the Aoe_LayoutConditions module. They are already contained in the release archive.

This leads to confusion. We should explain each installation method individually:

  1. composer: composer require integer-net/solr-magento1
  2. from ZIP:
    1. download archive from release page (link to release page)
    2. place files into Magento root
  3. manual installation from Git:
    1. place files from "src" into Magento root
    2. copy lib to lib and from src/Solr to lib/IntegerNet_Solr from solr-base repository (link)
    3. copy app to app from layout conditions module (link)
avstudnitz commented 7 years ago

I'd suggest not mentioning the "manual installation from Git" part - either use composer, or use the package we are providing in the "Releases" section on GitHub.