diff --git a/README.md b/README.md index 4a2a829c..9189b143 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,28 @@ http://fossology.github.io/atarashi ## Steps for Installation +### Installing dependencies + +Dependencies are required before building Atarashi. You can install them in +following ways: + +- `pip install -r requirements.txt` + +OR + +- `# python setup.py install_deps` + +However, the dependencies are installed while installing Atarashi (running +[install command](#install)) + ### Build (optional) -- `$ python setup.py build` +- Install the dependencies: + + `$ pip install -r requirements.txt` +- Build the package using Setuptools: + + `$ python setup.py build` - Build will generate 3 new files in your current directory 1. `data/Ngram_keywords.json` 2. `licenses/.csv` @@ -35,11 +54,6 @@ http://fossology.github.io/atarashi - `# python setup.py install` -### Installing just dependencies - -- `pip install -r requirements.txt` - - ## How to run Get the help by running `atarashi -h` or `atarashi --help` diff --git a/setup.py b/setup.py index c453e746..140c38a0 100755 --- a/setup.py +++ b/setup.py @@ -84,10 +84,12 @@ def run(self): global install_options global build_requirements global ext_links + + install_only_user = [] if os.geteuid() != 0: - install_options += ['--user'] + install_only_user = ['--user'] - subprocess.run(install_options + build_requirements, check = True) + subprocess.run(install_options + install_only_user + build_requirements, check = True) for package in ext_links: subprocess.run(install_options + ['-e', package], check = True)