Skip to content

Commit 5e0a2a8

Browse files
committed
docs: instruction if translation are missing
1 parent 0ab5db3 commit 5e0a2a8

File tree

1 file changed

+75
-58
lines changed

1 file changed

+75
-58
lines changed

README.md

Lines changed: 75 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,3 @@
1-
# Development Setup
2-
3-
### Clone mercurial repository.
4-
```shell
5-
hg clone http://hg.code.sf.net/p/roundup/code roundup
6-
```
7-
8-
### Make python virtual env and activate it
9-
```shell
10-
cd roundup
11-
python -m venv .
12-
```
13-
#### For linux and mac
14-
```shell
15-
source bin/activate
16-
```
17-
#### For windows powershell
18-
```shell
19-
.\scripts\Activate.ps1
20-
```
21-
22-
### Install roundup
23-
```shell
24-
python -m pip install .
25-
```
26-
27-
### Clone tracker only repo.
28-
```shell
29-
git clone https://github.com/UMB-CS-682-Team-03/tracker.git
30-
```
31-
32-
### Init the demo tracker with default ./demo
33-
```shell
34-
roundup-demo -b sqlite
35-
```
36-
37-
### Move the files from tracker dir to demo dir
38-
#### For linux and mac
39-
```shell
40-
cp -r ./tracker/**/* ./demo
41-
cp -r ./tracker/.git ./tracker/.gitignore ./demo
42-
```
43-
#### For windows powershell
44-
```shell
45-
xcopy .\tracker .\demo /s #say yes to all
46-
```
47-
48-
1. Now you are done setting up developing environment.
49-
2. Open the roundup folder in VScode.
50-
3. Any new changes are only to be done in demo directory.
51-
4. git is initialized to track origin in demo directory (for windows check if .git folder is copied to the demo)
52-
531
# Roundup - Classhelper
542
## `<roundup-classhelper>`
553
## Why there is need of `<roundup-classhelper>` in the issue tracker?
@@ -224,7 +172,78 @@ Copy the following files into your Roundup instance `html` directory:
224172

225173
After copying these files, you can use the `<roundup-classhelper>` component in your Roundup templates.
226174

175+
# Missing translations
176+
To set up translations for the <roundup-classhelper> component, follow these steps:
177+
178+
1. In your Roundup instance's Demo/locale directory, create a new file if not exists with the name __.po (e.g., de.po for German).
179+
180+
2. After the header, add the translation entries for the <roundup-classhelper> component. For example, for German, you can add:
181+
msgid "Submit"
182+
msgstr "gehen"
183+
184+
msgid "Next"
185+
msgstr "nächste"
186+
187+
msgid "name"
188+
msgstr "name"
189+
190+
3. Save the __.po file.
227191

192+
4. Restart your Roundup instance.
193+
194+
This should get you the missing translations, for more details refer roundup documentation for translations.
195+
196+
# Development Setup
197+
198+
### Clone mercurial repository.
199+
```shell
200+
hg clone http://hg.code.sf.net/p/roundup/code roundup
201+
```
202+
203+
### Make python virtual env and activate it
204+
```shell
205+
cd roundup
206+
python -m venv .
207+
```
208+
#### For linux and mac
209+
```shell
210+
source bin/activate
211+
```
212+
#### For windows powershell
213+
```shell
214+
.\scripts\Activate.ps1
215+
```
216+
217+
### Install roundup
218+
```shell
219+
python -m pip install .
220+
```
221+
222+
### Clone tracker only repo.
223+
```shell
224+
git clone https://github.com/UMB-CS-682-Team-03/tracker.git
225+
```
226+
227+
### Init the demo tracker with default ./demo
228+
```shell
229+
roundup-demo -b sqlite
230+
```
231+
232+
### Move the files from tracker dir to demo dir
233+
#### For linux and mac
234+
```shell
235+
cp -r ./tracker/**/* ./demo
236+
cp -r ./tracker/.git ./tracker/.gitignore ./demo
237+
```
238+
#### For windows powershell
239+
```shell
240+
xcopy .\tracker .\demo /s #say yes to all
241+
```
242+
243+
1. Now you are done setting up developing environment.
244+
2. Open the roundup folder in VScode.
245+
3. Any new changes are only to be done in demo directory.
246+
4. git is initialized to track origin in demo directory (for windows check if .git folder is copied to the demo)
228247

229248
# Running the Test Suite
230249

@@ -233,13 +252,12 @@ After copying these files, you can use the `<roundup-classhelper>` component in
233252
- GeckoDriver (for Firefox)
234253

235254
### Installation Instructions
236-
1. **Selenium Installation**:
237-
Open your terminal or command prompt and run:
238-
python -m pip install selenium==4.18.1
239255

240-
2. **GeckoDriver Installation**:
241-
pip install geckodriver==0.0.1
256+
Enable the python virtual environment then proceed to install the following packages
242257

258+
```shell
259+
python -m pip install selenium geckodriver
260+
```
243261

244262
#### To run the code in a Headless Environment:
245263
Set "HEADLESS = TRUE " in line 12.
@@ -250,4 +268,3 @@ After copying these files, you can use the `<roundup-classhelper>` component in
250268

251269
### Run the test suite
252270
python test_classhelper.py
253-

0 commit comments

Comments
 (0)