From 9ab7ac74c8fa17d91e3c586118fa79d45ddfcd1b Mon Sep 17 00:00:00 2001 From: Tobias Kunze Date: Mon, 6 Nov 2023 11:39:55 +0100 Subject: [PATCH] Remove references to -superplugin --- .github/workflows/run.yml | 23 +++++++---------------- README.rst | 4 ++-- 2 files changed, 9 insertions(+), 18 deletions(-) diff --git a/.github/workflows/run.yml b/.github/workflows/run.yml index e0f0f24..27a69c8 100644 --- a/.github/workflows/run.yml +++ b/.github/workflows/run.yml @@ -25,31 +25,22 @@ jobs: run: cookiecutter . --no-input - name: Init git repo (required for check-manifest) run: git config --global user.email "you@example.com" && git config --global user.name "Your Name" && git init && git add . && git commit -m 'Initial commit' - working-directory: pretalx-superplugin + working-directory: pretalx-foobar - name: Install pretalx run: pip install pretalx - working-directory: pretalx-superplugin + working-directory: pretalx-foobar - name: Install Dependencies run: pip install isort flake8 black docformatter twine check-manifest pytest pytest-django -Ue . - working-directory: pretalx-superplugin - - name: Run isort - run: isort -c . - working-directory: pretalx-superplugin - - name: Run flake8 - run: flake8 . - working-directory: pretalx-superplugin - - name: Run black - run: black --check . - working-directory: pretalx-superplugin + working-directory: pretalx-foobar - name: Run check-manifest run: check-manifest . - working-directory: pretalx-superplugin + working-directory: pretalx-foobar - name: Build package run: python setup.py sdist - working-directory: pretalx-superplugin + working-directory: pretalx-foobar - name: Check package run: twine check dist/* - working-directory: pretalx-superplugin + working-directory: pretalx-foobar - name: Run tests run: py.test tests - working-directory: pretalx-superplugin + working-directory: pretalx-foobar diff --git a/README.rst b/README.rst index 2d35eac..1815a33 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,7 @@ A simple `cookiecutter`_ template to bootstrap a `pretalx`_ plugin. Usage ----- -Let's pretend you want to create a pretalx plugin called "superplugin". +Let's pretend you want to create a pretalx plugin called "foobar". First, create a virtual environment and install the ``cookiecutter`` package using pip. Next, use it to bootstrap your project folder:: @@ -35,7 +35,7 @@ project folder created for you:: Now, change to the newly created directory:: - $ cd pretalx-superplugin + $ cd pretalx-foobar VoilĂ , there's your plugin structure! See pretalx' `documentation`_ for more info.