Skip to content

Commit

Permalink
update install method
Browse files Browse the repository at this point in the history
  • Loading branch information
iaacornus committed Aug 19, 2022
1 parent 591fbbe commit cc99391
Showing 1 changed file with 7 additions and 16 deletions.
23 changes: 7 additions & 16 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@ The project can be installed using the `.whl` in releases section using your pyt

## From source

### 1

One way to install the project from source is by building it using the build system. Install the dependencies with:

```
pip install build setuptools rich==12.4.4
pip install -r requirements.txt
```

And using your distro's respective package manager, install texlive or any other LaTeX distributions. In Fedora, CentOS, and RHEL:

```
sudo dnf/rpm-ostree/yum install texlive-scheme-full
```

Then inside the project dir, to build the `.whl` file do:
Expand All @@ -27,16 +31,3 @@ python setup.py build
```

And finally if the former was used, the resulting `.whl` file under `dists/` dir can be installed via `pip`.

### 2
Since the current version of simtex, is under alpha (v0.1.0a), there is no package and install script yet. Clone the repository:

```
git clone -b devel https://github.com/iaacornus/simtex
```

Install the dependencies, currently, the python dependency used is only `rich==12.4.4` which can be installed via `pip`. If you plan to use `-b` and `-B` command, you need a tex compiler, by default the program uses `PdfLaTeX`, which can be installed with `texlive` or other LaTeX distribution from your distro.

Then create the config directory: `mkdir $HOME/.config/simtex && cp ./simtex/examples/config/code_conf.txt ./simtex/examples/config/simtex.json -t $HOME/.config/simtex/`.

And place the source code in your `$PYTHONPATH`, since the command that is used is `python -m src.cli [COMMANDS] [OPTIONS]`, therefore, the source code must be in `$PYTHONPATH`. Then finally, you can add an alias to your `$HOME/.bashrc` or shell config file, with `simtex="python -m src.cli`.

0 comments on commit cc99391

Please sign in to comment.