mirror of
https://github.com/PR0M3TH3AN/SeedPass.git
synced 2025-09-07 14:58:56 +00:00
docs: clarify install and add CI
This commit is contained in:
22
.github/workflows/python-ci.yml
vendored
Normal file
22
.github/workflows/python-ci.yml
vendored
Normal file
@@ -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
|
14
README.md
14
README.md
@@ -58,7 +58,7 @@ git clone https://github.com/PR0M3TH3AN/SeedPass.git
|
|||||||
Navigate to the project directory:
|
Navigate to the project directory:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd SeedPass/src
|
cd SeedPass
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Create a Virtual Environment
|
### 2. Create a Virtual Environment
|
||||||
@@ -93,7 +93,7 @@ Install the required Python packages and build dependencies using `pip`:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install --upgrade pip
|
pip install --upgrade pip
|
||||||
pip install -r requirements.txt
|
pip install -r src/requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@@ -101,16 +101,16 @@ pip install -r requirements.txt
|
|||||||
After successfully installing the dependencies, you can run SeedPass using the following command:
|
After successfully installing the dependencies, you can run SeedPass using the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python main.py
|
python src/main.py
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running the Application
|
### Running the Application
|
||||||
|
|
||||||
1. **Start the Application:**
|
1. **Start the Application:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python main.py
|
python src/main.py
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Follow the Prompts:**
|
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**:
|
SeedPass includes a small suite of unit tests. After activating your virtual environment and installing dependencies, run the tests with **pytest**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install -r requirements.txt
|
pip install -r src/requirements.txt
|
||||||
pytest
|
pytest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user