Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@zaikunzhang
zaikunzhang committed Sep 28, 2024
1 parent ef5f036 commit ace544b
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion templates/README.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ https://github.com/equipez/bibliographie/blob/main/ref.bib
Usage:

- `latexmk` or `make` or `make pdf` to get the pdf file.
- `make bib` to get the BibTeX file; make sure to set the document to the draft mode, i.e., \documentclass[draft]{article}
- `make bib` to get the BibTeX file; make sure to set the document to the draft mode, i.e.,
\documentclass[draft]{article}.
- `make all` to compile everything and get the BibTeX file.
- `make clean` to clean up the directory.

1 comment on commit ace544b

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log or 📝 job summary for details.

Unrecognized words (7)

gmail
lineno
linenumberfont
linenumbersep
marginparsep
mathlines
scriptsize

Some files were automatically ignored 🙈

These sample patterns would exclude them:

^\Qbiber/example_biber-tool.conf\E$

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To accept these unrecognized words as correct and update file exclusions, you could run the following commands

... in a clone of the [email protected]:equipez/textools.git repository
on the main branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/equipez/textools/actions/runs/11082709140/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary
Dictionary Entries Covers Uniquely
cspell:fullstack/dict/fullstack.txt 419 1 1
cspell:latex/dict/latex.txt 434 1 1
cspell:typescript/dict/typescript.txt 1098 1
cspell:software-terms/dict/softwareTerms.txt 1288 1
cspell:python/src/python/python-lib.txt 2417 1

Consider adding them (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

      with:
        extra_dictionaries:
          cspell:fullstack/dict/fullstack.txt
          cspell:latex/dict/latex.txt
          cspell:typescript/dict/typescript.txt
          cspell:software-terms/dict/softwareTerms.txt
          cspell:python/src/python/python-lib.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

check_extra_dictionaries: ''
Pattern suggestions ✂️ (1)

You could add these patterns to .github/actions/spelling/patterns.txt:

# Automatically suggested patterns
# hit-count: 4 file-count: 2
# latex
\\(?:n(?:ew|ormal|osub)|r(?:enew)|t(?:able(?:of|)|he|itle))(?=[a-z]+)
Warnings (2)

See the 📜action log or 📝 job summary for details.

ℹ️ Warnings Count
ℹ️ candidate-pattern 2
ℹ️ noisy-file 1

See ℹ️ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Please sign in to comment.