feat(docs): add emojis for installation

walledai · Aug 9, 2024 · d57f4c4 · d57f4c4
1 parent 9388b6d
commit d57f4c4
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/docs/installation.md b/docs/installation.md
@@ -1,6 +1,6 @@
-# Installation
+# 🛠️Installation
 
-## Installing from PyPI
+## 🐍 Installing from PyPI
 
 Yes, we have published WalledEval on PyPI! To install WalledEval and all its dependencies, the easiest method would be to use `pip` to query PyPI. This should, by default, be present in your Python installation. To, install run the following command in a terminal or Command Prompt / PowerShell:
 
@@ -16,13 +16,13 @@ $ python -m pip install walledeval
 
 Here too, `python` or `pip` might be replaced with `py` or `python3` and `pip3` depending on the OS and installation configuration. If you have any issues with this, it is always helpful to consult [Stack Overflow](https://stackoverflow.com/).
 
-## Installing from Source
+## 📦 Installing from Source
 
 To install from source, you will need to undertake the following steps
 1. Clone Most Recent Repository Version
 2. Install Library Using Poetry
 
-### Git
+### ⚡ Git
 
 [Git](https://git-scm.com/) is needed to install this repository. This is not completely necessary as you can also install the zip file for this repository and store it on a local drive manually. To install Git, follow [this guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
 
@@ -34,7 +34,7 @@ $ git clone https://github.com/walledai/walledeval.git
 
 This stores a copy in the folder `walledeval`. You can then navigate into it using `cd walledeval`.
 
-### Poetry
+### 📖 Poetry
 
 This project can be used easily via a tool known as [Poetry](https://python-poetry.org/). This allows you to easily reflect edits made in the original source code! To install `poetry`, you can also install it using `pip` by typing in the command as follows:
 
@@ -58,7 +58,7 @@ $ poetry shell
 
 You can run the above script to enter a specialized shell to run commands within the virtual environment, including accessing the Python version with all the required dependencies to use WalledEval at its finest!
 
-## Notes during Installation
+## 🗒️ Notes during Installation
 
 Some features in our library are NOT ACCESSIBLE via the base dependencies installed in WalledEval. This is due to various dependency mismatches. Here is a list of what is not accessible and how you can use them.