Skip to content

Commit

Permalink
Updated installation info in README
Browse files Browse the repository at this point in the history
  • Loading branch information
bjheinen committed Mar 2, 2023
1 parent fe0db1e commit 8d2dd0b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
14 changes: 14 additions & 0 deletions LiquidDiffract/scripts/ld_launcher.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
'''
Fallback launcher script for LiquidDiffract!
Run python ld_launcher.py
'''
__author__ = 'Benedict J. Heinen'
__copyright__ = 'Copyright 2023, Benedict J. Heinen'
__license__ = 'GNU GPL v3'
__email__ = '[email protected]'

from LiquidDiffract.LiquidDiffract import main
main()
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Dependencies are handled automatically when installing with *pip*.

The simplest way to install LiquidDiffract is directly from PyPI with pip:

```$ pip install LiquidDiffract```
```$ python3 -m pip install LiquidDiffract``` (on Windows use: ```py -m pip install LiquidDiffract```)

The source code is directly available [here](https://github.com/bjheinen/LiquidDiffract/archive/master.zip)

Expand Down Expand Up @@ -101,7 +101,9 @@ To run the software use the command

```$ LiquidDiffract```

or run *'LiquidDiffract.py'* from the installation directory ```$ python LiquidDiffract.py```
If this fails setuptools may have placed the script in a directory not on your path. The location is usually a user or python specific scripts/bin folder, e.g. /usr/local/bin, ~/anaconda3/bin/, or Python\Python311\Scripts\

Alternatively, run *'ld_launcher.py'* from the scripts folder of the installation directory ```$ python ld_launcher.py```

### Basic Usage

Expand Down

0 comments on commit 8d2dd0b

Please sign in to comment.