Skip to content

Commit

Permalink
Merge pull request #14 from Soumya624/edit_readme
Browse files Browse the repository at this point in the history
Minor Modifications in README for Detailed Instructions
  • Loading branch information
TolisChal authored Aug 24, 2023
2 parents 2c1b509 + 9d29793 commit 4fa1035
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ The `volesti` package provides [R](https://www.r-project.org/) with functions fo
To use the development version of `volesti` that includes the C++ code, you need to clone the repository and fetch the submodule. Follow these steps:

* Clone the main `Rvolesti` repository.
* Change into `include` directory inside `src`:
```
cd src
cd include
```
* Fetch the submodule from the [volesti](https://github.com/GeomScale/volesti) repository:
```
git submodule update --recursive --init --remote
```
* Install volesti by running:
* Build package by running:
```
Rcpp::compileAttributes()
devtools::build()
```
* Install Rvolesti by running:
```
install.packages("volesti")
```
Expand All @@ -35,11 +35,14 @@ The package-dependencies are: `Rcpp`, `RcppEigen`, `BH`.
* [Wikipage with Tutorials and Demos](https://github.com/GeomScale/volesti/wiki)
* [Tutorial given to PyData meetup](https://vissarion.github.io/tutorials/volesti_tutorial_pydata.html)

## How to update the volesti R package
## How to update the volesti R package?

The C++ source code is retrieved from [volesti](https://github.com/GeomScale/volesti) package and placed in `src/include` of the current repository. To update the current C++ code we have to follow two steps:

- Update the `cran_include` branch in [volesti](https://github.com/GeomScale/volesti) (this can be done by opening a PR, e.g. https://github.com/GeomScale/volesti/pull/277)
- Update the `cran_include` branch in [volesti](https://github.com/GeomScale/volesti)
- Clone the main `volesti` repository
- Checkout to the `cran_include` branch
- Update your code and open a PR similar to https://github.com/GeomScale/volesti/pull/277
- Retrieve the new `include` directory using submodule
```
git submodule update --recursive --init --remote
Expand All @@ -56,5 +59,4 @@ Copyright (c) 2012-2023 Vissarion Fisikopoulos

Copyright (c) 2018-2023 Apostolos Chalkis

You may redistribute or modify the software under the GNU Lesser General Public License as published by Free Software Foundation, either version 3 of the License, or (at your option) any later version. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.

You may redistribute or modify the software under the GNU Lesser General Public License as published by Free Software Foundation, either version 3 of the License, or (at your option) any later version. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.

0 comments on commit 4fa1035

Please sign in to comment.