Skip to content

Commit

Permalink
edited readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tclose committed Mar 19, 2024
1 parent d239e75 commit 7d0a621
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 155 deletions.
132 changes: 0 additions & 132 deletions .github/workflows/fileformats-ci-cd.yaml

This file was deleted.

15 changes: 9 additions & 6 deletions related-packages/fileformats-extras/README.rst
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
FileFormats-CHANGEME Extras
======================================
FileFormats-medimage-CHANGEME Extras
====================================

.. image:: https://github.com/nipype/pydra-freesurfer/actions/workflows/ci-cd.yaml/badge.svg
:target: https://github.com/nipype/pydra-freesurfer/actions/workflows/ci-cd.yaml


This is a extras module for the `fileformats-CHANGEME <https://github.com/nipype/pydra-freesurfer/>`__
This is a extras module for the `fileformats-medimage-CHANGEME <https://github.com/nipype/pydra-CHANGEME/>`__
fileformats extension package, which provides additional functionality to format classes (i.e. aside
from basic identification and validation), such as conversion tools, metadata parsers, test data generators, etc...
from basic identification and validation), such as conversion tools, metadata parsers,
sample data generators, etc...


Quick Installation
------------------

This extension can be installed for Python 3 using *pip*::

$ pip3 install fileformats-CHANGEME-extras
$ pip3 install fileformats-medimage-CHANGEME-extras

This will install the core package and any other dependencies
This will install the package, base packages, and any other dependencies required to
implement the extra functionality.

License
-------
Expand Down
23 changes: 6 additions & 17 deletions related-packages/fileformats/README.rst
Original file line number Diff line number Diff line change
@@ -1,32 +1,21 @@
How to customise this template
==============================
FileFormats-medimage-CHANGEME
=============================

#. Rename the `related-packages/fileformats/CHANGEME` directory to the name of the fileformats subpackage (e.g. `medimage_fsl`)
#. Search and replace "CHANGEME" with the name of the fileformats subpackage the extras are to be added
#. Replace name + email placeholders in `pyproject.toml` for developers and maintainers
#. Add the extension file-format classes
#. Ensure that all the extension file-format classes are imported into the extras package root, i.e. `fileformats/CHANGEME`
#. Delete these instructions

...

FileFormats Extension - CHANGEME
====================================
.. image:: https://github.com/nipype/pydra-CHANGEME/actions/workflows/ci-cd.yml/badge.svg
:target: https://github.com/nipype/pydra-CHANGEME/actions/workflows/ci-cd.yml

This is the "CHANGEME" extension module for the
`fileformats <https://github.com/ArcanaFramework/fileformats-core>`__ package
This is an extension module of the `fileformats <https://github.com/ArcanaFramework/fileformats>`__
package for defining file formats that are specific to the CHANGME software toolkit.


Quick Installation
------------------

This extension can be installed for Python 3 using *pip*::

$ pip3 install fileformats-CHANGEME
$ pip3 install fileformats-medimage-CHANGEME

This will install the core package and any other dependencies
This will install the format extensions and dependent base packages.

License
-------
Expand Down

0 comments on commit 7d0a621

Please sign in to comment.