Skip to content

armgit / solr

Public Imported from GitHub
0

Apache Solr open-source search software

Describe in README how to build solr from source (#2294)

Vincenzo D'Amorebead9bbaacb2
diff --git a/README.md b/README.md
index f3333c9d163..12fdc47b94b 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,28 @@ Guide](https://solr.apache.org/guide/solr/latest/getting-started/solr-tutorial.h
- Slack: Solr Community Channel. Sign up at https://s.apache.org/solr-slack
- IRC: `#solr` on [libera.chat](https://web.libera.chat/?channels=#solr)
+## Developer Documentation
+
+Learn more about developing Solr by reading through the developer docs in [./dev-docs](./dev-docs) source tree or building Solr from source in [./dev-docs/solr-source-code.adoc](./dev-docs/solr-source-code.adoc)
+
+### Quickstart
+
+Solr uses [Gradle](https://gradle.org/) for its build system. Here are some useful hints to build and run Solr locally:
+
+- To build a Solr dev distribution:
+
+```
+./gradlew dev
+```
+
+- To run the Solr dev distribution locally:
+
+```
+cd ./solr/packaging/build/dev
+bin/solr start -c
+```
+
+- Open a web browser and go to http://localhost:8983/solr/ to access the Solr Admin interface. You can also use the `bin/solr` script to create and manage Solr collections. For example use the `bin/solr post` tool to index some sample data.
## Get Involved
Please review [CONTRIBUTING.md](CONTRIBUTING.md) for information on contributing to the project.
@@ -84,4 +106,3 @@ To get involved in the developer community:
- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
- IRC: `#solr-dev` on [libera.chat](https://web.libera.chat/?channels=#solr-dev)
-Learn more about developing Solr by reading through the developer docs in [./dev-docs](./dev-docs) source tree.