Re: [PATCH 2/5] Add a toplevel README
Carlos O'Donell <[email protected]> Thu, 7 Mar 2024 15:25:09 -0500
| Newsgroups | org.linuxfoundation.lists.cti-tac |
|---|---|
| Organization | Red Hat |
| Message-ID | <[email protected]> |
On 3/7/24 14:30, Siddhesh Poyarekar wrote: > Add basic instructions to allow one to test and later submit changes for > review and inclusion. > > Signed-off-by: Siddhesh Poyarekar <[email protected]> Content looks good though, you can keep my RB and push so long as you call it README.md. Reviewed-by: Carlos O'Donell <[email protected]> > --- > README | 15 +++++++++++++++ > 1 file changed, 15 insertions(+) > create mode 100644 README > > diff --git a/README b/README > new file mode 100644 > index 0000000..f0a7f64 > --- /dev/null > +++ b/README > @@ -0,0 +1,15 @@ > +CTI documentation portal > +======================== > + > +You need sphinxcontrib-spelling and piccolo-theme to build html pages > +from the rst sources, both of which are available through pip. Once you > +have them, run > + > + make html > + > +To build the html pages for testing. > + > +Submitting changes > +------------------ > + > +Send your patches to [email protected]. -- Cheers, Carlos.