keepyourmouthshut/docs/development.md

# Pointers for Developers

## How to start

- If you want to develop in a local environment, simply clone the repo `git clone https://github.com/rajtilakjee/kyms.git` and start developing.
- If you want to develop on a Gitpod, click on the following link:

  [Open in Gitpod](https://gitpod.io/#https://github.com/rajtilakjee/kyms-cli)

## Dependencies

- All the dependencies for the library are given in the `requirements.txt` files. You can use `pip -r install requirements.txt` to install the dependencies.

## Dev Dependencies

There are only 2 dev dependencies as of now:

- black
- ruff
chore: update dependency requirements and documentation setup - Updated requirements.txt to reflect changes in dependencies. - Installed all necessary dependencies, including development dependencies. - Implemented documentation using MkDocs with the Material theme for comprehensive project documentation. 2023-11-10 15:19:41 +00:00			`# Pointers for Developers`

			`## How to start`

			- If you want to develop in a local environment, simply clone the repo `git clone https://github.com/rajtilakjee/kyms.git` and start developing.
			`- If you want to develop on a Gitpod, click on the following link:`

chore: update project structure and configurations - Modified various project templates in .github/ISSUE_TEMPLATE for consistency and relevance. - Updated .pre-commit-config.yaml to enhance code quality checks and formatting. - Adjusted CODE_OF_CONDUCT.md to align with project guidelines. - Added documentation in docs/development.md for development specifics. - Added new files in the source directory: - generated_podcast_mp3s/__init__.py - generated_podcast_scripts/__init__.py - main.py - music package with multiple .mp3 files - prompts package with different podcast prompt scripts - utils package with various utility modules. 2023-11-11 05:28:52 +00:00			`[Open in Gitpod](https://gitpod.io/#https://github.com/rajtilakjee/kyms-cli)`
chore: update dependency requirements and documentation setup - Updated requirements.txt to reflect changes in dependencies. - Installed all necessary dependencies, including development dependencies. - Implemented documentation using MkDocs with the Material theme for comprehensive project documentation. 2023-11-10 15:19:41 +00:00
			`## Dependencies`

			- All the dependencies for the library are given in the `requirements.txt` files. You can use `pip -r install requirements.txt` to install the dependencies.

			`## Dev Dependencies`

			`There are only 2 dev dependencies as of now:`

			`- black`
			`- ruff`