Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
j-bernard committed Dec 4, 2020
1 parent bf3c0eb commit 107dfe3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ The following modules are reusable Django apps that can be included in other Dja
* `lgr_validator` contains the code related the label validation module.
* `lgr_tools` contains the code related to all utilities: testing LGR and label sets, LGR comparisons, etc.
* `lgr_renderer` contains the code and templates used to generate the static exports of the LGR (HTML only for now).
* `lgr_basic` contains the code related to the simple LGR interface.

## Acknowledgment

This toolset was implemented by Viagenie (Audric Schiltknecht, Julien Bernard,
David Drouin and Marc Blanchet) and Wil Tan on an ICANN contract.
David Drouin, Vincent Gonzalez and Marc Blanchet) and Wil Tan on an ICANN contract.

## License

Expand Down Expand Up @@ -53,7 +54,7 @@ THE POSSIBILITY OF SUCH DAMAGE.
### Pre-requisites

* Operating system: Tested on Linux and Mac OS X
* Python 2.7, >= 3.4
* Python >=3.6
* [LibXML2](http://www.xmlsoft.org/) [MIT License] used by the lxml Python bindings
* [ICU4C](http://site.icu-project.org/) [ICU License]
* Python modules (listed in `etc/requirements.txt`, or dependencies thereof)
Expand Down Expand Up @@ -183,6 +184,7 @@ Some notes for developers
* `src/lgr_validator/templates` contains validator-specific templates
* `src/lgr_tools/templates` contains tool-specific templates
* `src/lgr_renderer/templates` contains renderers (HTML output) templates
* `src/lgr_basic/templates` contains simple interface (HTML output) templates


#### Static Assets (CSS, Javascript, Images)
Expand Down
2 changes: 1 addition & 1 deletion bin/bootstrap
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ DSITE="src/lgr_web"

if [ ! -e venv ]; then
echo "==> Creating virtualenv"
virtualenv venv || exit 3
virtualenv -p python3 venv || exit 3
fi

# activate virtualenv
Expand Down

0 comments on commit 107dfe3

Please sign in to comment.