Macintosh-HW/RASCSI
1
0
Fork 0
mirror of https://github.com/akuker/RASCSI.git synced 2024-05-29 01:41:27 +00:00
Code Issues Projects Releases Wiki Activity

Updating README.md to reflect the project file structure (#633)

Browse Source 
* Updating README.md to reflect the changes made to the project file structure

* Added corrections as per comments

Co-authored-by: Nemanja Lukic <nemanja.lukic@forgerock.com>
This commit is contained in:
n4al 2022-02-02 04:51:51 +00:00 committed by GitHub
parent 651aa456bd
commit 0e6e710e52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
python/web/README.md
View File

@ -3,6 +3,8 @@
## Setup local dev env ## Setup local dev env
```bash ```bash
# Change to python/web/src
$ cd python/web
# Make a virtual env named venv # Make a virtual env named venv
$ python3 -m venv venv $ python3 -m venv venv
# Use that virtual env in this shell # Use that virtual env in this shell
@ -10,7 +12,7 @@ $ source venv/bin/activate
# Install requirements # Install requirements
$ pip install -r requirements.txt $ pip install -r requirements.txt
# Use mocks and a temp dir - start the web server # Use mocks and a temp dir - start the web server
$ BASE_DIR=/tmp/images/ PATH=$PATH:`pwd`/mock/bin/ cd src && python3 web.py $ BASE_DIR=/tmp/images/ PATH=$PATH:`pwd`/mock/bin/ cd python/web && PYTHON_COMMON_PATH=$(dirname $PWD)/common/src PYTHONPATH=$PWD/src:${PYTHON_COMMON_PATH} python3 src/web.py
``` ```
### Mocks for local development ### Mocks for local development
@ -43,7 +45,7 @@ We use the Flask-Babel library and Flask/Jinja2 extension for i18n.
It uses the 'pybabel' command line tool for extracting and compiling localizations. It uses the 'pybabel' command line tool for extracting and compiling localizations.
Activate the Python venv in src/web/ to use it: Activate the Python venv in src/web/ to use it:
``` ```
$ cd src/web/ $ cd python/web
$ source venv/bin/activate $ source venv/bin/activate
$ pybabel --help $ pybabel --help
``` ```
@ -94,7 +96,7 @@ msgstr ""
Install the gettext package and use msgfmt to see the translation progress. Install the gettext package and use msgfmt to see the translation progress.
``` ```
$ sudo apt install gettext $ sudo apt install gettext
$ cd src/web/ $ cd python/web/src
$ msgfmt --statistics translations/sv/LC_MESSAGES/messages.po $ msgfmt --statistics translations/sv/LC_MESSAGES/messages.po
215 translated messages, 1 untranslated message. 215 translated messages, 1 untranslated message.
``` ```