matthias/clang-uml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Moved installation instructions to separate doc page

Browse Source
This commit is contained in:
Bartek Kryza
2023-01-07 15:34:50 +00:00
parent 0ace023985
commit f1bae8289e
2 changed files with 7 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@@ -46,71 +46,7 @@ More comprehensive documentation can be found [here](./docs/README.md).
## Installation
### Distribution packages
#### Ubuntu
```bash
# Currently supported Ubuntu versions are Focal, Jammy and Kinetic
sudo add-apt-repository ppa:bkryza/clang-uml
sudo apt update
sudo apt install clang-uml
```
#### Fedora
```bash
# Fedora 36
wget https://github.com/bkryza/clang-uml/releases/download/0.3.0/clang-uml-0.3.0-1.fc36.x86_64.rpm
sudo dnf install ./clang-uml-0.3.0-1.fc36.x86_64.rpm
# Fedora 37
wget https://github.com/bkryza/clang-uml/releases/download/0.3.0/clang-uml-0.3.0-1.fc37.x86_64.rpm
sudo dnf install ./clang-uml-0.3.0-1.fc37.x86_64.rpm
```
#### Conda
```bash
conda config --add channels conda-forge
conda config --set channel_priority strict
conda install -c bkryza/label/clang-uml clang-uml
```
### Building from source
First make sure that you have the following dependencies installed:
```bash
# Ubuntu (clang version will vary depending on Ubuntu version)
apt install ccache cmake libyaml-cpp-dev clang-12 libclang-12-dev libclang-cpp12-dev
# macos
brew install ccache cmake llvm yaml-cpp
```
Then proceed with building the sources:
```bash
git clone https://github.com/bkryza/clang-uml
cd clang-uml
# Please note that top level Makefile is just a convenience wrapper for CMake
make release
release/clang-uml --help
# To build using a specific installed version of LLVM use:
LLVM_VERSION=14 make release
# Optionally
make install
# or
export PATH=$PATH:$PWD/release
# On macos, it is necessary to build clang-uml using the same llvm against which it is linked, e.g.
export CC=/usr/local/opt/llvm/bin/clang
export CCX=/usr/local/opt/llvm/bin/clang++
LLVM_VERSION=14 make release
```
Installation instruction for `Linux`, `macos` and `Windows` can be found [here](./docs/installation.md).
## Usage

14
docs/installation.md
View File

@@ -33,14 +33,12 @@ conda install -c bkryza/label/clang-uml clang-uml
### Building from source
#### Linux
First make sure that you have the following dependencies installed:
```bash
# Ubuntu (clang version will vary depending on Ubuntu version)
apt install ccache cmake libyaml-cpp-dev clang-12 libclang-12-dev libclang-cpp12-dev
# macos
brew install ccache cmake llvm yaml-cpp
```
Then proceed with building the sources:
@@ -62,9 +60,9 @@ export PATH=$PATH:$PWD/release
```
#### macos
```bash
# On macos, it is necessary to build clang-uml using the same llvm against which it is linked, e.g.
brew install llvm
brew install ccache cmake llvm yaml-cpp
export CC=/usr/local/opt/llvm/bin/clang
export CCX=/usr/local/opt/llvm/bin/clang++
@@ -75,10 +73,9 @@ LLVM_VERSION=14 make release
##### Visual Studio native build
These steps present how to build and use `clang-uml` using Visual Studio only without any
`vcpkg` or `choco` dependencies package managers.
These steps present how to build and use `clang-uml` natively using Visual Studio only.
First, install the following dependencies:
First, install the following dependencies manually:
* [Python 3](https://www.python.org/downloads/windows/)
* [Git](https://git-scm.com/download/win)
@@ -89,6 +86,7 @@ First, install the following dependencies:
Create installation directory for `clang-uml` and its dependencies:
```bash
# This is where our working clang-uml binary will be located
# If you change this path, adapt all consecutive steps
mkdir C:\clang-uml
# This directory will be removed after build
mkdir C:\clang-uml-tmp