forked from HLahoti/ryng
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tuts.html
160 lines (158 loc) · 8.84 KB
/
tuts.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" href="style.css" />
<link rel="icon" href="logo_golden.png" />
<title>Ryng Memory tool</title>
</head>
<body id="ind-body">
<div id="loader"></div>
<div id="content-help">
<div id="head">Ryng Memory tool - README.</div>
<div id="text-help">
Ryng is a flash-card-based memory
testing tool. It uses mathematical and psychological models to
help you remember data efficiently and easily.
<br /><br />Requirements: mySQL - To start Ryng: <br /><br />>
On Microsoft windows: Choose Start <br /><br />> All programs
<br /><br />> Ryng Memory tool The Ryng login window will appear
with boxes for user credentials. Hover your mouse over any
icon/button to see what it does. - To login to your Ryng
account: <br /><br />> Under the "mySQL password:" section: Type
the password to your local mySQL connection. It should be the
same password that you use to enter mySQL. <br /><br />> Under
the "Username:" section: If this is your first time or you want
to create a new account, type a new username here. Later on you
can enter this username to access your Ryng account.
<br /><br />> Click the Submit button. The login window will
close and the main window will appear on the screen. - Using the
main window: <br /><br />> In the centre there will be an area
with the headings "Decks", "Due" and "New". This is the treeview
where all your created decks and information about them will
appear. If you have no decks then this area will be empty.
Otherwise you will see the names of decks, how many cards are
due to be learnt and how many are new. You can right-click on a
deck to rename/delete it. <br /><br />> Above the main treeview
of the decks, you will see 3 buttons representing a plus sign, a
file with a magnifying glass and a light bulb/moon respectively.
On clicking the plus sign, the Add Cards/Decks window appears.
This window will allow you to create decks and add cards to
them. See "Using Add Cards/Decks window" for more information.
On clicking the files symbol, the Browse Cards window
appears.This window allows you to browse all your created decks,
cards, assign them flags, find cards by their names, flags, card
state or find duplicates. See "Using Browse Cards window" for
more information. On clicking the lightbulb/moon symbol the
theme of the program switches between light and dark mode. In
light mode this symbol appears as a moon and in dark mode it
appears as a lightbulb. <br /><br />> Below the treeview, you
can see two buttons labelled "Test all Cards" and "Test"
respectively. You have to first select a deck that you want to
test yourself with. Then click Test button if you want the
program to test you using it's algorithm. Otherwise click Test
all Cards button if you want to learn all cards. On clicking
either option, the treeview disappears and cards start appearing
to test you. See "Using test window" for more information.
<br /><br />> At the top right, you can see a red circle with 2
yellow arrows in it. This is the refresh button. Click on it to
display the latest updated data in the treeview. Auto-refreshing
takes place every few seconds anyway.
<br /><br />> At the top left, under the title "Main window",
you can see a button labelled "Options". Click on it to open the
Options menu. Here you will see 3 options: Clear data, Logout,
Delete account. On clicking the Clear data option, all the data
in your Ryng account is deleted, including information about
your decks and cards. Your account still exists, just without
any decks. On clicking the Logout option, the Main window with
the treeview closes and you are taken back to the login screen.
On clicking the Delete account option, your account with all
it's data is lost and can't be accessed again. You are taken
back to the login screen as in the Logout option above. - Using
Add cards/decks window: <br /><br />> On the top left there is a
button labelled "Choose Deck". Click on it to open a menu where
you can choose a deck you have already created to add new cards
to it or click on the "Add deck" option to create a new deck.
<br /><br />> When you click on the "Add deck" option, a text
bar appears under the heading "Deck". Type the name of your new
deck here. Then there are radio buttons below to select the
intensity of learning (more or less intensive) and whether to
allow reverse cards or not. Select your requirements for this
deck. Then click on the Add option below to create this deck.
<br /><br />> When you click on an already created deck, 3 text
fields appear under the headings "Front", "Back" and "Notes".
Here type the text at the front of the card under "Front", the
text at the back of the card under "Back" and extra notes under
"Notes". Once done, click on the Add option to add the card to
the deck. <br /><br />> Once done you can close the Add
Cards/Decks window. - Using Browse Cards window: <br /><br />> A
large window with many options appears on the screen. There is
again a large tree-view with the headings "Front" and "Back".
This is where all the cards with their fronts and backs will be
displayed. <br /><br />> On the left there are 3 text fields
with drop-down menus: > The first one is to choose a deck from
the decks you created in this account. On choosing a deck, all
the cards of that deck are displayed in the main treeview.
<br /><br />> The second one is to sort cards by their flags
(colours). On selecting a flag, only the cards of that flag
(colour) will appear in the treeview. <br /><br />> The third
one is to sort cards by their state, either new or learning.
<br /><br />> There is also a search bar above the treeview
where you can type the details of a card and it will display
cards with matching search terms. <br /><br />> There are 3 text
fields below the treeview. When you select a card from the main
treeview, it's details will be displayed here. You can change
these by selecting a text field and typing new data.
<br /><br />> You can click the "Find Duplicates" button below
this to find cards with the same data as the selected one.
<br /><br />> There are 5 options below the "Find Duplicates"
button in different colours. You can select any one of these to
assign a flag to your selected card.
<br /><br />> At the bottom of the screen there are 2 buttons
representing "Save" and "Delete" from left to right
respectively. Click on "Save" to apply the changes made above to
a single card. Click on "Delete" to delete the selected card.
<br /><br />> Once done, you can close the Browse Cards window.
- Using test window: <br /><br />> Once a testing option is
selected, cards start flashing one by one, depending on the deck
and option you have selected. <br /><br />> The front of a card
is displayed. You have to try and remember the information on
the back of the card. Once you are sure, click on the cards
symbol at the bottom to show the back of the card. <br /><br />>
On clicking the cards symbol, the entire card with all it's
information is displayed to you, along with 5 options at the
bottom rated from "Easy" to "Forgot". Rate yourself using these
options based on how well you were able to remember the
information on this card. <br /><br />> Once you're done, click
on the green arrow symbol at the bottom to go to the next card.
All the cards selected by the computer will be displayed to you
like this. If at any time you want to go back to the main
window, you can click the red arrow symbol at the top. Otherwise
the program will automatically take you back to the main window
after completing all the ready cards. <br /><br />> In the main
window, the decks are displayed with updated card information
reflecting the changes after you have learnt a particular deck.
<br /><br />Happy remembering!
</div>
</div>
<div id="bottoms">
<div class="credit">
Made by
<a class="highlight" href="mailto:[email protected]"
>Lahoax</a
>,
<a class="highlight" href="mailto:[email protected]"
>Impaler</a
>, and
<a class="highlight" href="mailto:[email protected]"
>Wanderer</a
>
</div>
<div class="credit">
<a class="highlight" href="index.html">Home</a>
</div>
</div>
</body>
</html>