Skip to content

Commit abdb671

Browse files
Nathaniel ImelNathaniel Imel
authored andcommitted
update installation instructions
1 parent 3ec9683 commit abdb671

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,16 @@ Longer term goals for ALTK include providing support for:
4242

4343
## Installing ALTK
4444

45-
1. Install via pip:
45+
1. Download or clone this repository and navigate to the root folder.
4646

47-
`python3 -m pip install git+https://github.com/nathimel/altk.git`
48-
49-
2. Get the required packages by running
47+
2. Create a fresh conda environment with the required packages by runing
5048

5149
`conda env create --file environment.yml`
5250

51+
3. Install ALTK
52+
53+
`pip install -e .`
54+
5355
## Getting started
5456

5557
- For an introduction to efficient communication research, here is a [survey paper](https://www.annualreviews.org/doi/abs/10.1146/annurev-linguistics-011817-045406) of the field.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name="altk",
8-
version="0.0.1",
8+
version="1.0.0",
99
author="Nathaniel Imel",
1010
author_email="nimel@uw.edu",
1111
description="The Artificial Language ToolKit",

0 commit comments

Comments
 (0)