Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
md-arif-shaikh committed Mar 23, 2023
1 parent 304de12 commit aa7421a
Showing 1 changed file with 2 additions and 23 deletions.
25 changes: 2 additions & 23 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
- [[#install][Install]]
- [[#set-local-time][Set local time]]
- [[#keybindings][Keybindings]]
- [[#adding-new-leagues][Adding new leagues]]
- [[#full-working-configuration][Full working configuration]]
- [[#common-interactive-functions][Common interactive functions]]
- [[#screenshots][Screenshots]]
Expand All @@ -23,14 +22,14 @@
- [[#soccer-scorecard][soccer-scorecard]]

* About the package
~Soccer~ is an [[https://www.gnu.org/software/emacs/][Emacs]] package for getting fixtures, results, standing table, scorecard etc for soccer (football) matches inside emacs. By default, the following leagues are included
~Soccer~ is an [[https://www.gnu.org/software/emacs/][Emacs]] package for getting fixtures, results, standing table, scorecard etc for soccer (football) matches inside emacs. Following are some the competitions that are included
- Premier League (England)
- La Liga (Spain)
- Ligue 1 (France)
- Bundesliga (Germany)
- Serie A (Italy)
- Championship (England)
and Adding new leagues or removing one from the default list is really easy, see [[#adding-new-leagues][Adding new leagues]]. All data are fetched from ~scorespro~ website.
All data are fetched from ~the guardian~ website.
* Installation and configuration
** Install
It's available in [[https://melpa.org/#/][Melpa]]. Look [[https://melpa.org/#/getting-started][here]] for instruction. One can also install it using ~straight~ and ~use-package~
Expand All @@ -56,31 +55,11 @@ Additionally you may want to make some keybindings to call the interactive funct
("C-c s t" . soccer-table)))
#+END_SRC
This will fetch and install the package from ~Melpa~, set your local ~utc-offset~ and set the above keybindings.
** Adding new leagues
You can add a new league or remove a league by modifying the variable ~soccer-leagues-alist~ either in your ~init~ file or using the customization method in ~Emacs~ (~M-x customize-variable~ ~Enter~ ~soccer-leagues-alist~ ~Enter~). Inside ~init~ file the variable ~soccer-leagues-alist~ could be configured in the following way
#+BEGIN_SRC emacs-lisp
(setq soccer-leagues-alist
'(("England" . "Premier League")
("Spain" . "Laliga")
("France" . "Ligue 1")
("Italy" . "Serie A")
("Germany" . "Bundesliga")
("England" . "Championship")))
#+END_SRC
** Full working configuration
#+BEGIN_SRC emacs-lisp
(use-package soccer
:straight (soccer :type git :host github :repo "md-arif-shaikh/soccer")
:init
(setq soccer-leagues-alist
'(("England" . "Premier League")
("Spain" . "Laliga")
("France" . "Ligue 1")
("Italy" . "Serie A")
("Germany" . "Bundesliga")
;;("uefa" . "Champions League")
;;("England" . "Championship")
))
:config
(setq soccer-time-local-time-utc-offset "+0530")
:bind (("C-c s f" . soccer-fixtures-next)
Expand Down

0 comments on commit aa7421a

Please sign in to comment.