Skip to content

Commit

Permalink
Add description and logo
Browse files Browse the repository at this point in the history
  • Loading branch information
coretl committed Jun 27, 2023
1 parent 98934ad commit 67cfc56
Show file tree
Hide file tree
Showing 7 changed files with 396 additions and 46 deletions.
24 changes: 4 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@ FastCS

|code_ci| |docs_ci| |coverage| |pypi_version| |license|

.. note::
FastCS is a control system agnostic framework for building Device support in
Python that will work for both EPICS and Tango without depending on either.

This project contains template code only. For documentation on how to
adopt this skeleton project see
https://DiamondLightSource.github.io/FastCS-cli
.. note::

This is where you should write a short paragraph that describes what your module does,
how it does it, and why people should use it.
This repository is in an early stage of development, and doesn't currently do the above!

============== ==============================================================
PyPI ``pip install FastCS``
Expand All @@ -19,20 +17,6 @@ Documentation https://DiamondLightSource.github.io/FastCS
Releases https://github.com/DiamondLightSource/FastCS/releases
============== ==============================================================

This is where you should put some images or code snippets that illustrate
some relevant examples. If it is a library then you might put some
introductory code here:

.. code-block:: python
from fastcs import __version__
print(f"Hello fastcs {__version__}")
Or if it is a commandline tool then you might put some example commands here::

$ python -m fastcs --version

.. |code_ci| image:: https://github.com/DiamondLightSource/FastCS/actions/workflows/code.yml/badge.svg?branch=main
:target: https://github.com/DiamondLightSource/FastCS/actions/workflows/code.yml
:alt: Code CI
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -191,5 +191,5 @@
html_show_copyright = False

# Logo
html_logo = "images/dls-logo.svg"
html_favicon = "images/dls-favicon.ico"
html_logo = "images/fastcs.svg"
html_favicon = "images/fastcs.svg"
Binary file removed docs/images/dls-favicon.ico
Binary file not shown.
11 changes: 0 additions & 11 deletions docs/images/dls-logo.svg

This file was deleted.

Loading

0 comments on commit 67cfc56

Please sign in to comment.