Skip to content

Commit

Permalink
Update docs and gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
dralley authored and Conan-Kudo committed Nov 24, 2019
1 parent 674ca35 commit ad1a9ea
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ develop-eggs
lib
lib64

# Compilation artifacts
_skbuild/

# Python distribution stuff
dist/
MANIFEST
*.egg-info/

# Installer logs
pip-log.txt

Expand Down
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,29 @@ You can use tito for building rpm package. From checkout dir:

tito build --rpm --test

## Building Python package
To create a binary "wheel" distribution, use:

python setup.py bdist_wheel

To create a source distribution, use:

python setup.py sdist

Installing source distributions require the installer of the package to have all of the build dependencies installed on their system, since they compile the code during installation. Binary distributions are pre-compiled, but they are likely not portable between substantially different systems, e.g. Fedora and Ubuntu.

Note: if you are building a bdist or installing the sdist on a system with an older version of Pip, you may need to install the ```scikit-build``` Python package first.

To install either of these packages, use:

pip install dist/{{ package name }}

To create an "editable" install of libcomps, use:

python setup.py develop

Note: To recompile the libraries and binaries, you muse re-run this command.

### Installing
* After successful build run:
make install
Expand Down

0 comments on commit ad1a9ea

Please sign in to comment.