Skip to content

Commit

Permalink
Adding a Mac tab for installing pip and virtual env (#112)
Browse files Browse the repository at this point in the history
* remove bracket from contribute

* adding mac tab commands for installing pip and virtual env
  • Loading branch information
HavivaB authored Jan 13, 2023
1 parent 603ead9 commit 1311d5c
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 2 deletions.
36 changes: 36 additions & 0 deletions website/docs/brain/brain-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,31 @@ If you want to install [`farm-ng-amiga`](https://pypi.org/project/farm-ng-amiga)

Install `pip3` & `virtualenv`:


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="linux" label="Linux" default>

```bash
sudo apt-get install python3-pip
sudo pip3 install virtualenv
```

</TabItem>
<TabItem value="macos" label="MacOs">

```bash
brew install python3
# to check if the installation was successful input command
pip --version
sudo pip3 install virtualenv
```
</TabItem>
</Tabs>


Start a virtual environment:

```bash
Expand Down Expand Up @@ -115,11 +135,27 @@ If you want to edit the package, or contribute, you can install from source.

Install `pip3` & setup a `virtualenv` (as above)

<Tabs>
<TabItem value="linux" label="Linux" default>

```bash
sudo apt-get install python3-pip
sudo pip3 install virtualenv
```

</TabItem>
<TabItem value="macos" label="MacOs">

```bash
brew install python3
# to check if the installation was successful input command
pip --version
sudo pip3 install virtualenv
```
</TabItem>
</Tabs>


Create and install the ``farm-ng-amiga`` Python package

```bash
Expand Down
19 changes: 17 additions & 2 deletions website/docs/contribute/website.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,27 @@ Though this is not a requirement and you are welcome to decide how / where to in

Install `pip3` & `virtualenv` (system level):

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="linux" label="Linux" default>

```bash
sudo apt-get install python3-pip
sudo pip3 install virtualenv
```
</TabItem>
<TabItem value="macos" label="MacOs">

```bash
brew install python3
sudo pip3 install virtualenv
```

</TabItem>
</Tabs>

Start a virtual environment:

```bash
Expand All @@ -68,8 +85,6 @@ source venv/bin/activate



import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="linux" label="Linux" default>
Expand Down

0 comments on commit 1311d5c

Please sign in to comment.