Skip to content

Commit e637329

Browse files
committed
Updated README
1 parent 8ba7593 commit e637329

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
This is a university project for teaching object-oriented programming at UniMoRe university (a.y. 2022/2023).
66

7-
87
- [Taskup](#taskup)
98
* [Get Started](#get-started)
109
+ [Dependencies](#dependencies)
@@ -72,6 +71,8 @@ After dependencies installation, this app can be opened using `main.py`.
7271

7372
`main.py` accepts some parameters based on execution modality.
7473

74+
If desired, you can create a working executable all-in-one by downloading PyInstaller and running the following command: `python3 -m eel main.py frontend/ --onefile`.
75+
7576
#### Modality
7677

7778
- `run`, `r` or _nothing_: launch the application
@@ -89,6 +90,7 @@ It is possible to manage application settings using `settings.json`, this file h
8990
Inserting custom settings in it, they override base default settings (managed by `SettingsManager`).
9091

9192
The settings available are:
93+
9294
- `vault_path`, a string that contains the path of directory in which will be saved the file which stores user's credentials
9395
- `current_project_path`, a string which contains the project path which will be loaded at the beginning
9496
- `projects_stored_paths`, a list of strings which contains the paths of already opened projects
@@ -106,6 +108,7 @@ The settings available are:
106108
- `edge` to open app in Edge browser
107109

108110
## Contribute
111+
109112
Everyone can contribute to this project.
110113

111114
Contributing is possible via pull request. You can develop something present in the [TODO](TODO.md) file or new feature from scratch.
@@ -212,12 +215,15 @@ For example, the _Manage Task Label_ page looks like this:
212215
In addition, if there are a lot of resources, it is possible to use filters.
213216

214217
## Home
218+
215219
**Home page** provides a set of sections where is possible:
220+
216221
- Watch _project information_
217222
- _Initialize_ new project
218223
- _Open_ projects
219224

220225
### Project Information
226+
221227
In this section, it is possible to see the project's path, its app's database, and if the logged-in user has the
222228
specific permission, this app can be removed from the project.
223229

@@ -231,7 +237,7 @@ To initialize a project, it is necessary to indicate the project's path and prov
231237
project's **project manager** who oversees the project.
232238

233239
> **WARNING**: Avoid to lose project manager's password, because the nature of this application makes it impossible
234-
to recover password without previously login.
240+
> to recover password without previously login.
235241
236242
If the indicated project is already initialized, checking _force initialize_ is possible to
237243
re-initialize project.
@@ -241,10 +247,10 @@ re-initialize project.
241247
![Home open](./doc/img/usr-doc/home-open.png)
242248

243249
Open project is possible in two-way:
250+
244251
- Manually entering the path
245252
- Selecting the path from a set of already opened projects
246253

247-
248254
# Documentation for Developers
249255

250256
This is a basic and simple documentation to illustrate this project to both old and new developers.
@@ -270,6 +276,7 @@ To run Sphinx doc:
270276
![structure of the project](./doc/img/dev-doc/structure-diagram.jpg)
271277

272278
### AppManager and its Services
279+
273280
**AppManager** is the class which provides methods to manage this app.
274281
In particular, AppManager has a set of _services_, which are classes that provide specific functionality.
275282
For example `AuthService` provides _authentication system_.
@@ -278,10 +285,12 @@ AppManager **has only one** service reference for each type to avoid duplication
278285
Therefore, the services need to be refreshed instead of re-instantiated.
279286

280287
#### ProjectManager
288+
281289
**ProjectManager** manage the _projects_, usually only one project at time.
282290
It allows initializing a new project or opening an existing project.
283291

284292
#### AuthService
293+
285294
**AuthService** provides _authentication system_.
286295
It also manages _vault_ (`vault.json`), where "remember me" user credentials are stored.
287296

0 commit comments

Comments
 (0)