Re: [PATCH 2/5] Add a toplevel README

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.
> 

Uses markdown, suggest the preferred README.md rather than README.

> Signed-off-by: Siddhesh Poyarekar <[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.