Skip to content

Commit

Permalink
📝 Update Setup Locally section in README.md
Browse files Browse the repository at this point in the history
Define both way to setup the project using `rye` and `pip`.
  • Loading branch information
arv-anshul committed Mar 12, 2024
1 parent 0f7e261 commit df77600
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 16 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,7 @@ __rough__/
arv.*
logs/
site/

# Do not ignore `requirements.lock` file because
# it is used to setup the project with `pip`
!requirements.lock
42 changes: 26 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,39 @@

## Setup Locally

1. Clone this repository with `git`:
Clone this repository with `git`:

```bash
git clone https://github.com/arv-anshul/arv-anshul.github.io
```
```bash
git clone https://github.com/arv-anshul/arv-anshul.github.io.git
```

2. Create a virtual environemt in the cloned directory, then install requirements from `requirements.txt` file using `pip` command:
### Install with `rye`

```bash
pip install -r requirements.txt
```
Install `rye` from [official website](https://rye-up.com) and create virtual environment using `rye`.

3. Now, you can easily serve the `docs/` folder as a website using `mkdocs` commands:
```bash
rye sync --no-dev
```

```bash
mkdocs serve
```
Now, you can easily serve the `docs/` folder as a website:

4. Optional, if you want to render all the `.md` as `.html`, `.css` and `.js` scripts, then run:
```bash
rye mkdocs serve
```

```bash
mkdocs build
```
### Install with `pip`

Install dependencies from `requirements.lock` (works as `requirements.txt`) file:

```bash
pip install -r requirements.lock
```

Now, you can easily serve the `docs/` folder as a website:

```bash
mkdocs serve
```

## Acknowledgement

Expand Down
74 changes: 74 additions & 0 deletions requirements.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# generated by rye
# use `rye lock` or `rye sync` to update this lockfile
#
# last locked with the following flags:
# pre: false
# features: []
# all-features: false
# with-sources: false

babel==2.14.0
# via mkdocs-material
certifi==2024.2.2
# via requests
charset-normalizer==3.3.2
# via requests
click==8.1.7
# via mkdocs
colorama==0.4.6
# via mkdocs-material
ghp-import==2.1.0
# via mkdocs
idna==3.6
# via requests
jinja2==3.1.3
# via mkdocs
# via mkdocs-material
markdown==3.5.2
# via mkdocs
# via mkdocs-material
# via pymdown-extensions
markupsafe==2.1.5
# via jinja2
# via mkdocs
mergedeep==1.3.4
# via mkdocs
mkdocs==1.5.3
# via mkdocs-markdownextradata-plugin
# via mkdocs-material
mkdocs-markdownextradata-plugin==0.2.5
mkdocs-material==9.5.9
mkdocs-material-extensions==1.3.1
# via mkdocs-material
packaging==23.2
# via mkdocs
paginate==0.5.6
# via mkdocs-material
pathspec==0.12.1
# via mkdocs
platformdirs==4.2.0
# via mkdocs
pygments==2.17.2
# via mkdocs-material
pymdown-extensions==10.7
# via mkdocs-material
python-dateutil==2.8.2
# via ghp-import
pyyaml==6.0.1
# via mkdocs
# via mkdocs-markdownextradata-plugin
# via pymdown-extensions
# via pyyaml-env-tag
pyyaml-env-tag==0.1
# via mkdocs
regex==2023.12.25
# via mkdocs-material
requests==2.31.0
# via mkdocs-material
simpleicons==7.21.0
six==1.16.0
# via python-dateutil
urllib3==2.2.0
# via requests
watchdog==4.0.0
# via mkdocs

0 comments on commit df77600

Please sign in to comment.