-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,6 +13,7 @@ We welcome contributions from the community. To contribute to this project, foll | |
|
||
1. Fork the repository on GitHub. | ||
2. Clone your forked repository to your local machine. | ||
3. ( This is an optional dependency: We are uing pre-commit hooks to adhere to coding standards. They will run automatically each time a commit is made. If any hook fails, the issues will need to be fixed before committing again.) | ||
|
||
All contributions to EyeON are made under the MIT license (MIT). | ||
|
||
|
@@ -31,6 +32,25 @@ source venv/bin/activate | |
git clone [email protected]:LLNL/pEyeON.git | ||
``` | ||
|
||
3. Build the docker image and run the container | ||
To build the image, run docker-build.sh: | ||
```bash | ||
./docker-build.sh | ||
``` | ||
|
||
To run the container, run docker-run.sh: | ||
```bash | ||
./docker-run.sh | ||
``` | ||
|
||
4. Optional Dependencies | ||
There are a few dev related dependencies and 1 docs dependency that can be optionally installed. | ||
```bash | ||
pip install .[dev, docs] or | ||
pip install .[dev] or | ||
pip install .[docs] | ||
``` | ||
|
||
## Code of Conduct | ||
|
||
All participants in the EyeON community are expected to follow our [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). | ||
|