From 0831a12a86b48d340f25129ee65780b61c0bee7e Mon Sep 17 00:00:00 2001
From: Patryk Bartkowiak <root@priv.patryk-bartkowiak.magisterka>
Date: Thu, 24 Oct 2024 19:03:24 +0000
Subject: [PATCH] updated README

---
 code/README.md | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/code/README.md b/code/README.md
index f8af3af..888ff89 100644
--- a/code/README.md
+++ b/code/README.md
@@ -1,14 +1,24 @@
-# codebert-training
-
-This code is used to train CodeBERT
+# Magisterka - Patryk Bartkowiak
 
 ## Required dependencies for the repository to work properly
 * [Git](https://git-scm.com/)
 * [PDM](https://pdm-project.org/en/latest/)
 
 ## How to run the training?
+### 1. Install PDM
+```bash
+curl -sSL https://pdm-project.org/install-pdm.py | python3 -
+```
+### 2. Go to the code directory and install dependencies
 ```bash
 cd ./code
 pdm install
+```
+### 3. Run training code
+```bash
 pdm run_training
+```
+or
+```
+pdm run src/train_codebert_mlm.py
 ```
\ No newline at end of file