A repository for hosting files containing the official nf-core logo along with instructions on how to create an nf-core logo for your pipeline.
- nf-core-logos/ - contains official
nf-corelogo and icon inai,pngandsvgformats. - example-logos/ - contains example pipeline logos in correct and incorrect rendering.
- make_logo/ - contains a template logo with
GenericNamefor a new pipeline, and a minimalist bash script to generate a new logo for your pipeline.
There are various ways you can create a logo for your pipeline. Each of these methods will generate the logo in png and svg formats e.g. NewPipeline_logo.png and NewPipeline_logo.svg
We provide a Docker Image on DockerHub that you may use to create logos for your pipeline easily:
docker run -v `pwd`:`pwd` -w `pwd` nfcore/logos NewPipelineYou will find your logos in png and svg format in /path/on/host/.
You can also pull the Docker image from DockerHub using Singularity to acheive the same outcome:
singularity pull logo.sif docker://nfcore/logos
singularity exec logo.sif /make_logo.sh NewPipelineYou can also run the bash script provided in this repository to generate the logo, however, you will need to install Inkscape beforehand. You will also need to download Maven Pro Bold Fonts and make them available to your system e.g. if you are running the script in a Linux environment you should be able to do this with the following commands:
mkdir -p ~/.fonts/
cd ~/.fonts/
wget 'https://raw.githubusercontent.com/google/fonts/master/ofl/mavenpro/static/MavenPro-Black.ttf'
wget 'https://raw.githubusercontent.com/google/fonts/master/ofl/mavenpro/static/MavenPro-Bold.ttf'
wget 'https://raw.githubusercontent.com/google/fonts/master/ofl/mavenpro/static/MavenPro-Medium.ttf'
wget 'https://raw.githubusercontent.com/google/fonts/master/ofl/mavenpro/static/MavenPro-Regular.ttf'Thereafter, you can download this repo using git and generate the logo:
git clone https://github.com/nf-core/logos.git
cd logos/make_logo
./make_logo.sh NewPipelineIf you have any questions or issues please send us a message on Slack.