From 15f2dc7a9896c14a30a20ce3769d3581e9db0494 Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Sat, 28 Jun 2025 20:25:35 -0400 Subject: [PATCH] docs: clarify install and add CI --- .github/workflows/python-ci.yml | 22 ++++++++++++++++++++++ README.md | 14 +++++++------- 2 files changed, 29 insertions(+), 7 deletions(-) create mode 100644 .github/workflows/python-ci.yml diff --git a/.github/workflows/python-ci.yml b/.github/workflows/python-ci.yml new file mode 100644 index 0000000..4fd0530 --- /dev/null +++ b/.github/workflows/python-ci.yml @@ -0,0 +1,22 @@ +name: CI + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: '3.11' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r src/requirements.txt + - name: Test with pytest + run: pytest diff --git a/README.md b/README.md index 2de6008..6e742e7 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ git clone https://github.com/PR0M3TH3AN/SeedPass.git Navigate to the project directory: ```bash -cd SeedPass/src +cd SeedPass ``` ### 2. Create a Virtual Environment @@ -93,7 +93,7 @@ Install the required Python packages and build dependencies using `pip`: ```bash pip install --upgrade pip -pip install -r requirements.txt +pip install -r src/requirements.txt ``` ## Usage @@ -101,16 +101,16 @@ pip install -r requirements.txt After successfully installing the dependencies, you can run SeedPass using the following command: ```bash -python main.py +python src/main.py ``` ### Running the Application 1. **Start the Application:** - ```bash - python main.py - ``` + ```bash + python src/main.py + ``` 2. **Follow the Prompts:** @@ -164,7 +164,7 @@ SeedPass allows you to manage multiple seed profiles (previously referred to as SeedPass includes a small suite of unit tests. After activating your virtual environment and installing dependencies, run the tests with **pytest**: ```bash -pip install -r requirements.txt +pip install -r src/requirements.txt pytest ```