diff --git a/README.md b/README.md index 8d60ea8d6..10c81fbc8 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ Visualize the latest recording you created by running the following command: python -m openadapt.visualize ``` -This will open your browser. It will look something like this: +This will open your browser. It will look like this: ![image](https://github.com/OpenAdaptAI/OpenAdapt/assets/774615/5d7253b7-ae12-477c-94a3-b388e4f37587) @@ -277,7 +277,7 @@ To set up the pre-commit hooks, follow these steps: pre-commit install ``` -Now, the pre-commit hooks are installed and will run automatically before each commit. They will enforce code quality standards and prevent committing code that doesn't pass the defined checks. +Now, the pre-commit hooks are installed and will run automatically before each commit. They will enforce code quality standards and prevent committing code that doesn't pass the defined checks. Please ensure to use the `black --preview .` if running black manually. # Submitting an Issue diff --git a/install/install_openadapt.sh b/install/install_openadapt.sh index 2986bc9ca..e411fc4b6 100644 --- a/install/install_openadapt.sh +++ b/install/install_openadapt.sh @@ -9,7 +9,10 @@ pythonCmd="python3.10" pythonVerStr="Python 3.10*" pythonInstallerLoc="https://www.python.org/ftp/python/3.10.11/python-3.10.11-macos11.pkg" -# Construct the repository URL +# Set default values when no parameters are provided +BRANCH=${BRANCH:-main} +REPO=${REPO:-https://github.com/MLDSAI/OpenAdapt.git} + REPO_URL="https://github.com/$REPO" ################################ HELPER FUNCTIONS ################################ diff --git a/openadapt/privacy/__init__.py b/openadapt/privacy/__init__.py index d58acf990..6756f19bc 100644 --- a/openadapt/privacy/__init__.py +++ b/openadapt/privacy/__init__.py @@ -1,4 +1 @@ -"""Package for the Privacy API. - -Module: __init__.py -""" +"""Package for the Privacy API."""