Skip to content

Commit

Permalink
Improved Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
KingZee committed Aug 7, 2019
1 parent 97fd66b commit ee10fe1
Showing 1 changed file with 26 additions and 6 deletions.
32 changes: 26 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,37 @@
# Shop Solver
> An application to solve scheduling problems written in Java.
This is currently still in early phase, and I will be updating this readme as required.
This library can solve all three types of scheduling problems (Flow-Shop, Job-Shop, and Open-Shop).

Problem and solution space encoding schemes are optimized across all three types with a permutation schedule definition.

It is extremely easy to implement any "Solver" for any of these types by inheriting from the base abstract Solver class and overriding corresponding methods.


## Dependencies :

This project uses JavaFX with some [JFoenix](https://github.com/jfoenixadmin/JFoenix) components for UI.
This project is built with JDK11 & Maven. It uses JavaFX 11 with some [JFoenix 9](https://github.com/jfoenixadmin/JFoenix) components for UI. JMH toolkit is included for micro-benchmarks.

## Troubleshooting :

After installing dependencies, the project can be run through the javafx-maven-plugin :

mvn clean
mvn javafx:compile
mvn javafx:run

If you would like to run using IntelliJ's built in runtime, you will need to have JavaFX 11 installed, and include the VM directives :

--module-path $PATH_TO_JAVAFX --add-modules javafx.controls,javafx.fxml

## Roadmap

## Release History
- [x] Build initial framework.
- [ ] Add example(s) of local search algorithm(s).
- [ ] Add example(s) of genetic algorithm(s).
- [ ] Add integrations for GPU computation (CUDA).
- [ ] Add benchmarking tools for algorithm comparison.

* 1.0.0
* Initial commit

## License

Distributed under the Apache license. See ``LICENSE`` for more information.

0 comments on commit ee10fe1

Please sign in to comment.