Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
Updated setup.py for dependencies
Updated/Fixed Makefile
  • Loading branch information
e3prom committed Feb 22, 2023
1 parent 6db66bc commit 2930902
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 17 deletions.
16 changes: 10 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
PYTHON=/usr/bin/env python
PYTHON=python3

deps: requirements.txt
pip install -r requirements.txt

docs:
@cd docs; \
cd docs; \
echo "Building documentation..."; \
pip install -r requirements.txt
@$(PYTHON) -m mkdocs build
pip install -r requirements.txt ; \
cd ..; \
$(PYTHON) -m mkdocs build

test:
@$(PYTHON) -m unittest discover tests
$(PYTHON) -m unittest discover tests

install:
$(PYTHON) setup.py install

clean:
rm -rf venv
find . -type f -name "*.pyc" -delete

.PHONY: init docs test
.PHONY: deps docs test install clean
15 changes: 5 additions & 10 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,21 @@ The above commands will automatically install all the required dependencies.

### Using git { #using-source data-toc-label="using git" }

First make sure you have `git` installed:

Fetch the source code from the official Kryptoxin repository:
First make sure you have `git` installed. Fetch the source code from the official Kryptoxin repository, and install the required the dependencies:

=== "Latest Development"

``` sh
git clone https://github.com/e3prom/kryptoxin
cd kryptoxin
python setup.py install
```

=== "0.9.1"

``` sh
git clone https://github.com/e3prom/kryptoxin
cd kryptoxin
git checkout tags/0.9.1
python setup.py install
```

Enter the repository directory and launch the install script:

```sh
cd kryptoxin
python setup.py install
```
6 changes: 5 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# -*- coding: utf-8 -*-
from setuptools import setup, find_packages

requirements = []
with open('requirements.txt', 'r') as fh:
for line in fh:
requirements.append(line.strip())

with open('README.md') as f:
readme = f.read()
Expand All @@ -25,4 +28,5 @@
"Topic :: Security",
],
python_requires=">=3.6",
install_requires = requirements
)

0 comments on commit 2930902

Please sign in to comment.