Merge pull request #33 from ArrogantGao/jg/clean-up2

Clean up repo

CITATION

@@ -0,0 +1,9 @@
+@misc{Gao2024,
+      title={Automated Discovery of Branching Rules with Optimal Complexity for the Maximum Independent Set Problem}, 
+      author={Xuan-Zhao Gao and Yi-Jia Wang and Pan Zhang and Jin-Guo Liu},
+      year={2024},
+      eprint={2412.07685},
+      archivePrefix={arXiv},
+      primaryClass={math.OC},
+      url={https://arxiv.org/abs/2412.07685}, 
+}

README.md

@@ -1,42 +1,39 @@
 # OptimalBranching.jl
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ArrogantGao.github.io/OptimalBranching.jl/stable/)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ArrogantGao.github.io/OptimalBranching.jl/dev/)
 [![Build Status](https://github.com/ArrogantGao/OptimalBranching.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ArrogantGao/OptimalBranching.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/ArrogantGao/OptimalBranching.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ArrogantGao/OptimalBranching.jl)
 
 
-`OptimalBranching.jl` is a Julia package that implements the optimal branching algorithm (paper coming soon). It is a meta package that contains the following submodules in the `lib` directory:
+`OptimalBranching.jl` is a Julia package that implements the optimal branching algorithm (arXiv: 2412.07685). It is a meta package that contains the following submodules in the `lib` directory:
 - `OptimalBranchingCore.jl`: the core algorithms for automatically generating optimal branching rules.
 - `OptimalBranchingMIS.jl`: the maximum independent set solver based on the optimal branching algorithm.
 
 ## Installation
 
-This package has already been registered, one can press `]` to enter the package manager and then enter
-```julia
-pkg> add OptimalBranching
-```
-to install the package.
+<p>
+OptimalBranching is a &nbsp;
+    <a href="https://julialang.org">
+        <img src="https://raw.githubusercontent.com/JuliaLang/julia-logo-graphics/master/images/julia.ico" width="16em">
+        Julia Language
+    </a>
+    &nbsp; package. To install OptimalBranching,
+    please <a href="https://docs.julialang.org/en/v1/manual/getting-started/">open
+    Julia's interactive session (known as REPL)</a> and press <kbd>]</kbd> key in the REPL to use the package mode, then type the following command
+</p>
 
-To use the latest version, one can install this repository manually by
+```julia
+pkg> add OptimalBranchingCore  # for the core algorithms
 
-```bash
-$ git clone https://github.com/ArrogantGao/OptimalBranching.jl
-$ cd OptimalBranching.jl
-$ make
+pkg> add OptimalBranching      # for utilities based on the core algorithms
 ```
 
-This will add the submodules and install the dependencies, the tests will be run automatically to ensure everything is fine.
+If you have problem to install the package, please [file us an issue](https://github.com/ArrogantGao/OptimalBranching.jl/issues/new).
 
 ## Get started
 
-Please stay in the project directory and type
-```bash
-$ julia --project
-```
-to start a Julia session in the project environment. Then you can test the functions by typing
 ```julia
-julia> using OptimalBranching, OptimalBranchingMIS.Graphs
+julia> using OptimalBranching, OptimalBranching.OptimalBranchingMIS.Graphs
 
 julia> graph = smallgraph(:tutte)
 {46, 69} undirected simple Int64 graph
@@ -51,3 +48,7 @@ For advanced usage, please refer to the [documentation](https://ArrogantGao.gith
 ## How to Contribute
 
 If you find any bug or have any suggestion, please open an [issue](https://github.com/ArrogantGao/OptimalBranching.jl/issues).
+
+## Citation
+
+If you find this package useful in your research, please cite the relevant paper in the [CITATION](CITATION) file.