Skip to content

Commit d4aefe3

Browse files
committed
docs: add git and make to requirements
1 parent 6109bcc commit d4aefe3

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ repos:
99
args: ["--ignore-words=codespell.txt"]
1010
exclude: 'codespell.txt|\.svg$'
1111
- repo: https://github.com/pre-commit/mirrors-prettier
12-
rev: v4.0.0-alpha.3
12+
rev: v4.0.0-alpha.4
1313
hooks:
1414
- id: prettier
1515
- repo: https://github.com/psf/black

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,16 @@ Wharton offers a variety of analytics and accounting courses. Some of the course
110110
These are just a few examples of the analytics and accounting courses offered at Wharton. The school offers a wide range of courses in these areas to provide students with a comprehensive understanding of financial analysis and decision-making.
111111
```
112112

113+
## Requirements
114+
115+
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). _pre-installed on Linux and macOS_
116+
- [make](https://gnuwin32.sourceforge.net/packages/make.htm). _pre-installed on Linux and macOS._
117+
- [OpenAI platform API key](https://platform.openai.com/).
118+
_If you're new to OpenAI API then see [How to Get an OpenAI API Key](./doc/OPENAI_API_GETTING_STARTED_GUIDE.md)_
119+
- [Pinecone](https://www.pinecone.io/) API key.
120+
- [Python 3.11](https://www.python.org/downloads/): for creating virtual environment used for building AWS Lambda Layer, and locally by pre-commit linters and code formatters.
121+
- [NodeJS](https://nodejs.org/en/download): used with NPM for local ReactJS developer environment, and for configuring/testing Semantic Release.
122+
113123
## Configuration defaults
114124

115125
Set these as environment variables on the command line, or in a .env file that should be located in the root of the repo.

0 commit comments

Comments
 (0)