Fix formatting errors in the README file

pull/334/head
Daniel Gray 5 years ago
parent 749671d945
commit dea5875b2f

@ -43,20 +43,20 @@ The (GPLv2+) source code used to build YaCy is distributed with the package (in
## Where is the documentation? ## Where is the documentation?
- [https://yacy.net](Homepage) - [Homepage](https://yacy.net)
- [https://searchlab.eu](International Forum) - [International Forum](https://searchlab.eu)
- [https://wiki.yacy.net/index.php/De:Start](German wiki) - [German wiki](https://wiki.yacy.net/index.php/De:Start)
- [https://wiki.yacy.net/index.php/Eo:Start](Esperanto wiki) - [Esperanto wiki](https://wiki.yacy.net/index.php/Eo:Start)
- [https://wiki.yacy.net/index.php/Fr:Start](French wiki) - [French wiki](https://wiki.yacy.net/index.php/Fr:Start)
- [https://wiki.yacy.net/index.php/Es:Start](Spanish wiki) - [Spanish wiki](https://wiki.yacy.net/index.php/Es:Start)
- [https://wiki.yacy.net/index.php/Ru:Start](Russian wiki) - [Russian wiki](https://wiki.yacy.net/index.php/Ru:Start)
- [https://yacy.net/en/Tutorials.html and https://yacy.net/de/Lehrfilme.html](Video tutorials) - [Video tutorials in English](https://yacy.net/en/Tutorials.html) and [video tutorials in German](https://yacy.net/de/Lehrfilme.html)
All these have (YaCy) search functionality combining all these locations into one search result. All these have (YaCy) search functionality combining all these locations into one search result.
## Dependencies? What other software do I need? ## Dependencies? What other software do I need?
You need Java 1.8 or later to run YaCy. (No Apache, Tomcat or mySQL or anything else) You need Java 1.8 or later to run YaCy. (No Apache, Tomcat or MySQL or anything else)
YaCy also runs on IcedTea 3. YaCy also runs on IcedTea 3.
See https://icedtea.classpath.org See https://icedtea.classpath.org
@ -97,7 +97,7 @@ a remote location. If you install YaCy on a server that is not your
workstation you must set an admin account immediately after the first start-up. workstation you must set an admin account immediately after the first start-up.
Open: Open:
http://<remote-server-address>:8090/ConfigAccounts_p.html http://<remote-server-address>:8090/ConfigAccounts_p.html
and set an admin account. and set an admin account.
@ -170,17 +170,17 @@ git clone https://github.com/yacy/yacy_search_server
Compiling YaCy: Compiling YaCy:
- You need Java 1.8 or later and [Apache Ant](https://ant.apache.org/). - You need Java 1.8 or later and [Apache Ant](https://ant.apache.org/).
- Compile: "ant clean all" - then you can "./startYACY.sh" or "./startYACY.bat". - Compile: `ant clean all` - then you can `./startYACY.sh` or `./startYACY.bat`.
- Create a release tarball: "ant dist". - Create a release tarball: `ant dist`.
- Create a macOS release: "ant distMacApp" (only works on macOS). - Create a macOS release: `ant distMacApp` (only works on macOS).
- Create a Debian release: "ant deb". - Create a Debian release: `ant deb`.
- Work with Eclipse: Within Eclipse you also need to start the ant build process. - Work with Eclipse: Within Eclipse you also need to start the ant build process.
because the servlet pages are not compiled by the Eclipse build process. because the servlet pages are not compiled by the Eclipse build process.
after the dist procedure, the release can be found in the RELEASE subdirectory. after the dist procedure, the release can be found in the RELEASE subdirectory.
Build with Maven: Build with Maven:
- For the first time go to the subdirectory libbuild (which contains the Maven parent POM). - For the first time go to the subdirectory libbuild (which contains the Maven parent POM).
- Compile with "mvn clean install -DskipTests", this will create all needed modules. - Compile with `mvn clean install -DskipTests`, this will create all needed modules.
- After this you can use just use the POM in the main directory to build YaCy with Maven. - After this you can use just use the POM in the main directory to build YaCy with Maven.
## APIs and attaching software ## APIs and attaching software
@ -195,7 +195,7 @@ scripts you can easily create more shell API access methods.
## Contact ## Contact
Visit the international YaCy forum](https://searchlab.eu) [Visit the international YaCy forum](https://searchlab.eu)
where you can start a discussion there in your own language. where you can start a discussion there in your own language.
Questions and requests for paid customization and integration into enterprise solutions. Questions and requests for paid customization and integration into enterprise solutions.

Loading…
Cancel
Save