Przeglądaj źródła

updated format of README.md

dmr1725 4 lat temu
rodzic
commit
34a1f198b8
1 zmienionych plików z 16 dodań i 16 usunięć
  1. 16
    16
      README.md

+ 16
- 16
README.md Wyświetl plik

@@ -6,33 +6,33 @@
6 6
 ### Description of the application
7 7
 The purpose of the Companion App is to facilitate the course selection process for students at the UPRRP. The concept is achieved by offering a variety of tools to the user:
8 8
 
9
-    1. Keeping a record of the courses that the student has already taken while they progress through their degree. 
9
+1. Keeping a record of the courses that the student has already taken while they progress through their degree. 
10 10
 
11
-    2. The app uses the data entered by the student to compute the GPA, this allows the user to keep track of it and have it handy for all academic purposes. 
11
+2. The app uses the data entered by the student to compute the GPA, this allows the user to keep track of it and have it handy for all academic purposes. 
12 12
 
13
-    3. It presents the list of classes that the university has made available for the upcoming semester. This allows the user to choose the courses that they look forward to enrolling in.
13
+3. It presents the list of classes that the university has made available for the upcoming semester. This allows the user to choose the courses that they look forward to enrolling in.
14 14
 
15
-    4. With the selected courses and their allocated times, the app provides the option to create an agenda with the selected courses in time-blocks organized in a weekly format.
15
+4. With the selected courses and their allocated times, the app provides the option to create an agenda with the selected courses in time-blocks organized in a weekly format.
16 16
 
17 17
 The goal is to help students organize themselves, practice their enrollments and evaluate all of their options before using the university's system for the official process.
18 18
 
19 19
 ### Requirements:
20
-    - Python 3.4+
21
-    - Postgres
22
-    - PgAdmin (UI to see your database): https://www.pgadmin.org/
23
-    - Ngrok free version: https://ngrok.com/
24
-    - Postman (test endpoints): https://www.postman.com/
25
-    - npm and node: https://www.npmjs.com/get-npm
26
-    - Expo ios or android mobile app to run application in physical device
27
-    - Android studio to run application in emulator
20
+- Python 3.4+
21
+- Postgres
22
+- PgAdmin (UI to see your database): https://www.pgadmin.org/
23
+- Ngrok free version: https://ngrok.com/
24
+- Postman (test endpoints): https://www.postman.com/
25
+- npm and node: https://www.npmjs.com/get-npm
26
+- Expo ios or android mobile app to run application in physical device
27
+- Android studio to run application in emulator
28 28
 
29 29
 ### SPECIAL NOTES BEFORE STARTING:
30 30
 While following the steps below, if you get the following messages:
31
-- ### Superuser creation skipped due to not running in a TTY. You can run manage.py createsuperuser in your project to create one manually.
32
-- ### Watching for file changes with StatReloader
31
+- **Superuser creation skipped due to not running in a TTY. You can run manage.py createsuperuser in your project to create one manually**
32
+- **Watching for file changes with StatReloader**
33 33
 Just add the word winpty at the beginning of each command. Examples:
34
-- ### winpty python manage.py createsuperuser
35
-- ### winpty python manage.py runserver
34
+- **winpty python manage.py createsuperuser**
35
+- **winpty python manage.py runserver**
36 36
 
37 37
 
38 38
 **Below are the steps to run the application**