Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation nits: license and bundling #147

Merged
merged 2 commits into from Jun 19, 2021
Merged

Documentation nits: license and bundling #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9008209
License is a section of the readme
rolandwalker Jun 19, 2021
84f5834
doc clarifications re: bundled chess library
rolandwalker Jun 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Expand Up @@ -13,6 +13,7 @@ An Emacs major-mode for chess PGN files, powered by Python.
* [Interactive Commands](#interactive-commands)
* [Minor Mode](#minor-mode)
* [Prior Art](#prior-art)
* [License](#license)
* [Compatibility and Requirements](#compatibility-and-requirements)

## Quickstart
Expand Down Expand Up @@ -41,8 +42,8 @@ Provides
`{comments}` and parenthesized `(variations)`.
* customizable faces
* navigation and selection commands
* computation of FEN at point (requires [chess](https://pypi.org/project/chess/) library)
* computation and display of board at point (requires [chess](https://pypi.org/project/chess/))
* computation of FEN at point (using the [chess](https://pypi.org/project/chess/) library)
* computation and display of board at point (using [chess](https://pypi.org/project/chess/))
* evaluation of board at point (requires [uci-mode](https://github.com/dwcoates/uci-mode))

## Interactive Commands
Expand Down
3 changes: 3 additions & 0 deletions pygn-mode.el
View file
Open in desktop
Expand Up @@ -60,6 +60,9 @@
;;
;; https://pypi.org/project/chess/
;;
;; A version of the Python chess library is bundled with this package.
;; Note that the chess library has its own license (GPL3+).
;;
;; Bugs
;;
;; `pygn-mode-after-change-function' should be made faster
Expand Down