Skip to content

Commit

Permalink
Move admonition below intro
Browse files Browse the repository at this point in the history
  • Loading branch information
blakeNaccarato committed Sep 21, 2024
1 parent 561bf0c commit 7d524f7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

[![All Contributors](https://img.shields.io/github/all-contributors/softboiler/copier-pipeline?color=ee8449&style=flat-square)](#contributors)

This is a Copier template for Python projects, allowing for template evolution over time and sharing across projects. It is strongly recommended you follow [dev machine setup](#dev-machine-setup) before following steps for [generating a project from this template](#generate-a-project-from-this-template). In short, you should have Git, VSCode, Copier, Python, and the cross-platform PowerShell (with profile configurations to activate `.env` variables), installed to get the most use out of this template.

> [!IMPORTANT]
> This template is diverging into one focused on engineering research pipelines in [`softboiler`](https://github.com/softboiler), and a more general one in [`copyit`](https://github.com/copyit-org). These will not be proper "forks" of one another, but will eventually be synchronized by tooling developed in the `copyit` organization. This template will continue to specialize until I graduate, after which the simpler version will be recovered and maintained at `copyit`.
This is a Copier template for Python projects, allowing for template evolution over time and sharing across projects. It is strongly recommended you follow [dev machine setup](#dev-machine-setup) before following steps for [generating a project from this template](#generate-a-project-from-this-template). In short, you should have Git, VSCode, Copier, Python, and the cross-platform PowerShell (with profile configurations to activate `.env` variables), installed to get the most use out of this template.

## Features

This template should set up tooling that will help you as you code. Contributor and CI workflows in this template are tested on Windows 2022, MacOS 13, and Ubuntu 22.04 runners. Static analysis "moves errors to the left", allowing you to catch issues as soon as possible. Linting and code checks run as you write to catch problems before you run/publish/package your code. Features include:
Expand Down

0 comments on commit 7d524f7

Please sign in to comment.