diff --git a/LICENSE.tXT b/LICENSE.txt similarity index 100% rename from LICENSE.tXT rename to LICENSE.txt diff --git a/README.md b/README.md index f52db46..2f52af3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -#ArcRoutingLibrary +# ArcRoutingLibrary [![DOI](https://zenodo.org/badge/11673331.svg)](https://zenodo.org/badge/latestdoi/11673331) -##Features +## Features * Collection of Common Algorithms * DCPP Solver (Edmonds) @@ -18,27 +18,27 @@ * OSM graph ingestion * Decoupled Improvement Procedure Framework -##About the Author +## About the Author -Oliver Lum is currently a PhD Candidate in the University of Maryland, College Park's Applied Mathematics and Scientific Computation (AMSC) program. His research focus is in combinatorial optimization over networks, specifically with regard to arc routing problems. +Oliver Lum is currently a PhD Candidate in the University of Maryland, College Park's Applied Mathematics and Scientific Computation (AMSC) program. His research focus is in combinatorial optimization over networks, specifically with regard to arc routing problems. -##Background +## Background -After being tasked with writing a solver for a new arc routing problem, and having zero code base to work from, the author identified several inconveniences: +After being tasked with writing a solver for a new arc routing problem, and having zero code base to work from, the author identified several inconveniences: * First, although Java is fast becoming the industry standard for most new projects, the vast majority of robust graph libraries were composed for C/C++ (e.g. Boost, LEMON, etc.) * Second, what libraries did exist were catered towards node-routing applications (consistent with literature), despite the close relationship between the two. * Third, software development in research is (for a variety of legitimate reasons), fairly stove-piped, leading to time lost re-implementing other methods both for comparison, as well as to solve sub-problems. -This library is intended to be a collection of problem abstractions and solver implementations for some common arc-routing problems. We hope that its existence reduces the time it takes for new researchers to get started. +This library is intended to be a collection of problem abstractions and solver implementations for some common arc-routing problems. We hope that its existence reduces the time it takes for new researchers to get started. -##License +## License -This library is released under the MIT license. For more details, see the License.txt +This library is released under the MIT license. For more details, see the [License](LICENSE.txt) -##Tutorial +## Tutorial -For some example code snippts, check out GeneralTestbed.java . +For some example code snippets, check out [GeneralTestbed.java](src/oarlib/test/GeneralTestbed.java). ## Special Thanks