Skip to content

Commit bf0237b

Browse files
authored
refactor: updated README file to reflect template changes (#258)
1 parent 32b4ecd commit bf0237b

File tree

1 file changed

+38
-12
lines changed

1 file changed

+38
-12
lines changed

README.rst

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,48 @@
1+
##############
2+
edX Bootstrap
3+
##############
4+
15
.. image:: https://badge.fury.io/js/%40edx%2Fedx-bootstrap.svg
26
:target: https://badge.fury.io/js/%40edx%2Fedx-bootstrap
37
.. highlight:: css
4-
5-
=============
6-
edX Bootstrap
7-
=============
8+
9+
********
10+
Purpose
11+
********
812

913
This library is an extension of `Bootstrap 4 <http://getbootstrap.com>`_
1014
for use with edX and openEdX.
1115

1216
Installation
13-
------------
17+
=============
1418

1519
Using npm::
1620

1721
npm install --save @edx/edx-bootstrap
1822

23+
Cloning and Startup
24+
===================
25+
26+
.. code-block::
27+
28+
29+
1. Clone your new repo:
30+
31+
``git clone https://github.com/openedx/edx-bootstrap.git``
32+
33+
2. Use node v18.x.
34+
35+
The current version of the micro-frontend build scripts support node 18.
36+
Using other major versions of node *may* work, but this is unsupported. For
37+
convenience, this repository includes an .nvmrc file to help in setting the
38+
correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
39+
40+
3. Install npm dependencies:
41+
42+
``cd edx-bootstrap && npm ci``
43+
1944
Usage
20-
-----
45+
=====
2146

2247
Add the following import in your project's base scss file::
2348

@@ -38,7 +63,7 @@ Alternatively, you can download this repo and use one of the compiled outputs:
3863
- ``dist/core/core.css`` (edX bootstrap & extensions only)
3964

4065
Theming
41-
-------
66+
=======
4267

4368
The content of a `theme.scss` file::
4469
@@ -66,29 +91,30 @@ and make changes. Then include it before you include edx-bootstrap::
6691
@import "overrides";
6792

6893
Getting Help
69-
------------
94+
============
95+
7096
If you’re having trouble, you can ask in the front-end channel on Slack or contact the Frontend Working Group:
7197

7298
- `#front-end <https://openedx.slack.com/messages/C0EUBSV7D>`_
7399
- `#frontend-working-group <https://openedx.slack.com/messages/C02BMP2RD5Y>`_
74100

75101
License
76-
-------
102+
=======
77103

78104
The code in this repository uses the Apache 2.0 license unless otherwise noted.
79105
Please see the `LICENSE file <https://github.com/openedx/edx-bootstrap/blob/master/LICENSE>`_
80106
for details.
81107

82108
Documentation
83-
-------------
109+
=============
84110

85111
Documentation details can be found in the `docs index.rst`_.
86112

87113
.. _docs index.rst: docs/index.rst
88114

89115

90116
How to Contribute
91-
-----------------
117+
=================
92118

93119
Contributions are very welcome, but for legal reasons, you must submit a
94120
signed `individual contributor agreement`_ before we can accept your
@@ -98,7 +124,7 @@ will make your contribution more likely to be accepted.
98124

99125

100126
Reporting Security Issues
101-
-------------------------
127+
=========================
102128

103129
Please do not report security issues in public. Please email
104130

0 commit comments

Comments
 (0)