Skip to content
This repository was archived by the owner on Jul 17, 2024. It is now read-only.

Commit b6b1fa1

Browse files
docs: Add badges to README and instructions for building from source (#70)
--------- Co-authored-by: Geoffrey De Smet <gds.geoffrey.de.smet@gmail.com>
1 parent 03dd634 commit b6b1fa1

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,15 @@
22

33
# Timefold Solver for Python
44

5-
[![PyPI](https://img.shields.io/pypi/v/timefold-solver "PyPI")](https://pypi.org/project/timefold-solver/)
5+
[![PyPI](https://img.shields.io/pypi/v/timefold-solver?style=for-the-badge& "PyPI")](https://pypi.org/project/timefold-solver/)
6+
[![License](https://img.shields.io/github/license/TimefoldAI/timefold-solver-python?style=for-the-badge&logo=apache)](https://www.apache.org/licenses/LICENSE-2.0)
7+
[![JVM support](https://img.shields.io/badge/Java-17+-brightgreen.svg?style=for-the-badge)](https://sdkman.io)
8+
[![Python support](https://img.shields.io/badge/Python-3.10+-brightgreen.svg?style=for-the-badge)](https://www.python.org/downloads)
9+
[![Commit Activity](https://img.shields.io/github/commit-activity/m/TimefoldAI/timefold-solver-python?label=commits&style=for-the-badge)](https://github.com/TimefoldAI/timefold-solver-python/pulse)
10+
11+
[![Stackoverflow](https://img.shields.io/badge/stackoverflow-ask_question-orange.svg?logo=stackoverflow&style=for-the-badge)](https://stackoverflow.com/questions/tagged/timefold)
12+
[![GitHub Discussions](https://img.shields.io/github/discussions/TimefoldAI/timefold-solver?style=for-the-badge&logo=github)](https://github.com/TimefoldAI/timefold-solver/discussions)
13+
[![GitHub Issues](https://img.shields.io/github/issues/TimefoldAI/timefold-solver-python?style=for-the-badge&logo=github)](https://github.com/TimefoldAI/timefold-solver-python/issues)
614

715
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=TimefoldAI_timefold-solver-python&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=TimefoldAI_timefold-solver-python)
816
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=TimefoldAI_timefold-solver-python&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=TimefoldAI_timefold-solver-python)
@@ -15,10 +23,27 @@ Cloud Optimization, Conference Scheduling, Job Shop Scheduling, Bin Packing and
1523

1624
Using Timefold Solver in Python is significantly slower than using Timefold Solver in Java or Kotlin.
1725

26+
## Get started with Timefold Solver for Python
27+
28+
* [Read a Getting Started guide](https://timefold.ai/docs)
29+
* [Clone the Quickstarts repository](https://github.com/TimefoldAI/timefold-quickstarts)
30+
1831
## Requirements
1932

2033
- [Install Python 3.10 or later.](https://www.python.org)
2134
- [Install JDK 17 or later](https://adoptium.net) with the environment variable `JAVA_HOME` configured to the JDK installation directory.
35+
For example, with [Sdkman](https://sdkman.io/):
36+
```shell
37+
$ sdk install java
38+
```
39+
40+
## Build from source
41+
42+
1. [Build the main branch of Timefold Solver for Java from source](https://github.com/TimefoldAI/timefold-solver?tab=readme-ov-file#build-from-source)
43+
2. Install the repo
44+
```shell
45+
$ pip install git+https://github.com/TimefoldAI/timefold-solver-python.git
46+
```
2247

2348
## Source code overview
2449

0 commit comments

Comments
 (0)