Skip to content

Commit

Permalink
feat: updated documentation (#741)
Browse files Browse the repository at this point in the history
* feat: updated documentation
* removed some 2u-specific documentation to the 2u  wiki (and corrected
  it there)
*  added some clarifying sentences about the limitations of the
   repository

FIXES: APER-2912
  • Loading branch information
deborahgu authored Dec 20, 2023
1 parent 8fc5f2b commit 4875b39
Showing 1 changed file with 3 additions and 14 deletions.
17 changes: 3 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ edX Credentials Themes

This repository holds themes for the edX Credentials Service.

Credentials-Themes contains styles and overrides for the rendering of Program Certificates awarded through edX.org.
It does not control any styles or overrides for anything except for rendered Program Certificates.

Building
--------

Expand All @@ -24,17 +27,3 @@ provider) where the strings can be translated.

Compile translated strings by running `make compile_translations`. This will produce a .mo file for each .po in the repo.
The .mo files are read by Django and are used to provide translations in the running application.

Developing in devstack
----------------------
In order to develop in devstack, make sure your devstack is running, then:

#. Switch your devstack to the `edX theme`_
#. Clone this repo into ``<devstack_folder>/src/``
#. ``cd <devstack_folder>/devstack/``
#. ``make dev.shell.credentials``
#. ``make requirements``
#. ``pip install -e /edx/src/credentials-themes`` - this will override the version that was installed in the previous step
#. ``make static``

.. _`edX theme`: https://github.com/openedx/edx-themes/blob/master/docs/guides/local-development.rst

0 comments on commit 4875b39

Please sign in to comment.