@@ -15,7 +15,9 @@ to suit your preferences and needs.
15
15
16
16
The simplest way to dive into Whombat is by downloading our pre-packaged
17
17
executable file. We've tailored versions for Windows, Mac OS, and Ubuntu. Head
18
- over to our GitHub repository's [ releases] ( https://github.com/mbsantiago/whombat/releases ) section to get the latest version.
18
+ over to our GitHub repository's
19
+ [ releases] ( https://github.com/mbsantiago/whombat/releases ) section to get the
20
+ latest version.
19
21
20
22
### Python Package
21
23
@@ -36,8 +38,8 @@ executable. This action spawns a new window that should resemble the following:
36
38
37
39
![ boot] ( ../assets/img/boot.png )
38
40
39
- After the window displays the "ready" message, open your preferred browser and
40
- navigate to:
41
+ After the window displays the "ready" message a browser will be opened on
42
+ Whombat, or open your preferred browser and navigate to:
41
43
42
44
http://localhost:5000
43
45
@@ -47,20 +49,29 @@ navigate to:
47
49
48
50
python -m whombat
49
51
50
- ## Login
52
+ ## First User
51
53
52
- Whombat welcomes you with a login form. Input your username and password to
53
- access the home page. Whombat's user system allows for multiple users, keeping
54
- track of everyone's work .
54
+ If this is your initial encounter with Whombat, you'll be greeted with a screen
55
+ to create your user profile. Please enter your details and set up your user
56
+ account .
55
57
56
- ![ login] ( ../assets/img/login.png )
58
+ !!! info "Your Information"
59
+
60
+ The details you provide here are stored locally on your computer and are
61
+ not shared with others. However, if you decide to download and share a dataset
62
+ or annotations, the information of the user who created them will be visible in
63
+ the exported files. Therefore, your data will only be shared with the people
64
+ you send these files to. If you wish to share your work, it is essential to
65
+ provide your information so that others can attribute you correctly and contact
66
+ you if needed.
57
67
58
- !!! warning "First time"
68
+ ## Login
69
+
70
+ For returning users, Whombat welcomes you with a login form. Enter your username
71
+ and password to access the home page. Whombat's user system supports multiple
72
+ users, allowing for individual work tracking.
59
73
60
- If this is your inaugural run of Whombat, you won't have a username and
61
- password. Not to worry, Whombat auto-generates a first user. Use the username
62
- **admin** and password **admin** for your initial login. Afterward, you can
63
- visit your profile to customize your username and password.
74
+ ![ login] ( ../assets/img/login.png )
64
75
65
76
## Home Screen
66
77
0 commit comments