Skip to content

Commit

Permalink
Add more comment notes about customisation. [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
ping committed Aug 18, 2022
1 parent 2922f8e commit 209cb1e
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 1 deletion.
7 changes: 7 additions & 0 deletions _recipes.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# --------------------------------------------------------------------
# This file defines default recipes distributed with newsrack.
# To customise your own instance, do not modify this file.
# Add your recipes to _recipes_custom.py instead and new recipe source
# files to recipes_custom/.
# --------------------------------------------------------------------

from _recipe_utils import Recipe, onlyon_days, onlyat_hours, onlyon_weekdays

# Only mobi work as periodicals on the Kindle
Expand Down
2 changes: 2 additions & 0 deletions _recipes_custom.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
from _recipe_utils import Recipe

# Define your custom recipes list here
# Example: https://github.com/ping/newsrack-fork-test/blob/custom/_recipes_custom.py

recipes: List[Recipe] = [
# Recipe(
# recipe="example",
Expand Down
4 changes: 4 additions & 0 deletions recipes/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
This folder holds the default recipes distributed with newsrack.

Do not add your custom recipes to this folder.
Put them in recipes_custom/ instead.
2 changes: 1 addition & 1 deletion recipes_custom/README.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Place your custom recipes (*.recipe.py) source files in this folder
Place your custom recipes (*.recipe.py or *.recipe) source files in this folder

0 comments on commit 209cb1e

Please sign in to comment.