Skip to content

Commit

Permalink
Updated documentation to reflect new versions for audit
Browse files Browse the repository at this point in the history
  • Loading branch information
SeriousHorncat committed Oct 4, 2023
1 parent cbe8cd7 commit 752f02c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ The following pre-requisites are required to be installed in the target *NIX env
deploying and testing Rosalution. Install environment dependencies below using
the respective installation instructions for your target environment.

- [Node.JS 16+](https://nodejs.org/en/) & [Classic Yarn](https://classic.yarnpkg.com/en/)
- [Node.JS 20.8+](https://nodejs.org/en/) & [Classic Yarn](https://classic.yarnpkg.com/en/)
- Node.JS recommends managing Node.JS installations with [nvm](https://www.npmjs.com/package/npx) - [install](https://github.com/nvm-sh/nvm#install--update-script)
- Yarn is not included with Node.JS with `nvm`. Run `npm install --global yarn` once Node.JS is installed. - [install](https://classic.yarnpkg.com/en/docs/install)
- [Python 3.8+](https://www.python.org/) - [Install](https://www.python.org/downloads/)
- [Python 3.11+](https://www.python.org/) - [Install](https://www.python.org/downloads/)
- `pip3` to install the required packages for development within a virtual environment
- `python venv` Some system installations of Python 3+ do not include python virtual environments that were added
in Python 3.3+. Additional installation and setup may be necessary if using Python packaged with an OS (such as Ubuntu).
Expand Down
2 changes: 1 addition & 1 deletion backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ isolated virtual environments for these projects.
All packages necessary for Rosalution development are installed into the `./backend/rosalution_env/` virtual
environment in the setup.sh script.

To create this isolation we use the python virtual environment [venv](https://docs.python.org/3.8/library/venv.html).
To create this isolation we use the python virtual environment [venv](https://docs.python.org/3.11/library/venv.html).
Refer to the python virtual environment for documentation.

Note: Make sure setup.sh script is run as this installs the rosalution_env and all it's dependencies.
Expand Down
6 changes: 3 additions & 3 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ for analysis.

### Dependencies

- [Node.JS 16+](https://nodejs.org/en/)
- [Node.JS 20.8+](https://nodejs.org/en/)
- Recommended to manageNode.JS versions with [nvm](https://www.npmjs.com/package/npx) - [install](https://github.com/nvm-sh/nvm#install--update-script)
- [Yarn - Classic](https://classic.yarnpkg.com/en/docs/getting-started) - [install](https://classic.yarnpkg.com/en/docs/install#windows-stable)

Expand Down Expand Up @@ -78,8 +78,8 @@ yarn test:coverage

#### Code Coverage

Code coverage configuration is managed in the `vite.config.js` and is generated
by [c8](https://github.com/bcoe/c8#readme).
Code coverage configuration is managed in the `vite.config.js`by [vitest configuration](https://vitest.dev/config/#coverage)
and is generated by [v8](https://v8.dev/blog/javascript-code-coverage#javascript-code-coverage-in-v8).

Visit
`<{root_project_path/rosalution/frontend/coverage/index.html}>` within the browser
Expand Down

0 comments on commit 752f02c

Please sign in to comment.