aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorzlg <zlg@zlg.space>2019-04-29 18:14:23 -0700
committerzlg <zlg@zlg.space>2019-04-29 18:14:23 -0700
commitc032a56d02fdc122667d79a3ba4905b89d99ba62 (patch)
treeba8fc0ef6d452b520f49ff0531e60158ed5980fd /README.md
parentsetup.py: Remove obsolete information (diff)
downloadvgstash-c032a56d02fdc122667d79a3ba4905b89d99ba62.tar.gz
vgstash-c032a56d02fdc122667d79a3ba4905b89d99ba62.tar.bz2
vgstash-c032a56d02fdc122667d79a3ba4905b89d99ba62.tar.xz
vgstash-c032a56d02fdc122667d79a3ba4905b89d99ba62.zip
README.md: Clarify a few details
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 2 insertions, 4 deletions
diff --git a/README.md b/README.md
index ab750b5..39c148a 100644
--- a/README.md
+++ b/README.md
@@ -21,8 +21,6 @@ vgstash is available via `pip`:
pip install [--user] vgstash
~~~
-Packages for vgstash on Gentoo Linux and Adélie Linux are on the TODO list.
-
Please note that vgstash is under heavy development at present. Do not install
unless you are interested in helping its development.
@@ -191,6 +189,7 @@ These are planned for the full 0.3 release:
* command line interface finished
* Match feature-set with `master`
+* Iron out any initial bugs on Windows and Mac (testers welcome!)
Goals planned for the 0.4 release:
@@ -204,5 +203,4 @@ Goals planned for the 1.0 release:
* Kivy-based interface (to release on Android via F-Droid)
-If this interests you, please [e-mail me](mailto:zlg+vgstash@zlg.space) or find
-me on the Fediverse: [@zlg@social.zlg.space](https://social.zlg.space/users/zlg)
+If this interests you, please [e-mail me](mailto:zlg+vgstash@zlg.space).

Copyleft 2009-2024 ZLG. Powered by cgit.

' class='logmsg'> 2018-10-18cli: show msg if game to be deleted is not in DBzlg2-2/+12 2018-10-18README: expand on usage, cover shell quotingzlg1-7/+99 2018-10-18cli: Tell the user when a game lacks noteszlg2-3/+15 2018-10-18Catch when an invalid list filter is passedzlg4-3/+24 Before, vgstash.DB.list_games() would default to 'allgames' and silently hide it when a filter wasn't found. This commit ensures that the vgstash package and CLI both indicate when an invalid filter is passed to them: * vgstash.DB.list_games() will return False on a failure to match; * vgstash_cli uses Click's Choice object to enforce the constraint 2018-10-12cli: Add zero-game import/export messageszlg2-11/+18 2018-10-10Bump to 0.3beta1 for PyPIzlg1-1/+1 2018-10-10Move tests and data to dedicated directoryzlg7-10/+26 Also tweaked the export command to report correctly. 2018-10-10cli: Add "export" commandzlg2-5/+54 The export command is like the import command; currently supporting YAML output, but ready to be expanded as needed. 2018-10-10cli: Add "import" commandzlg5-1/+76 Currently the import command will only accept YAML files, but is ready for expansion to other formats as needed. 2018-10-09Bump to 0.3alpha6 for PyPIzlg1-1/+1 2018-10-09cli: Add "notes" commandzlg2-4/+74 The "notes" command will show the user what their notes for a particular game are. The output can be piped anywhere the user wants, such as a pager or a file. If "notes" is passed with the "--edit" or "-e" flag, vgstash will open a temporary file with the game's notes already inside and edit it using the program pointed to by the EDITOR environment variable. When the editor is closed (with a successful exit status), vgstash updates the game's notes and exits. The defaults for the testing environment ("cat" for non-interactive, "vim" for interactive) may need tweaking on other operating systems. Patches for these platforms are very welcome. 2018-10-09update_game: ensure notes are also savedzlg1-2/+2 2018-10-09cli: add 'update' commandzlg3-20/+92 Two helper functions were also added to the vgstash package to ease client workflows. This commit marks the final core function necessary to manipulate a vgstash DB on the command line. 2018-10-06cli: Add "delete" commandzlg2-0/+19 Unlike the old version of vgstash, the new one does not accept row IDs as arguments for removal. Instead, it accepts two mandatory arguments: the title of the game, and the system it's on. This is in line with the database itself, using the title and system as primary keys. 2018-10-06Remove ID field from DBzlg3-38/+46 The sqlite database already uses a game's title and system as the primary keys. Row IDs are redundant. 2018-10-06cli: change "Status" heading to "Progress"zlg2-36/+40 2018-09-29Bump to 0.3alpha5 for PyPIzlg1-1/+1 2018-09-29cli: Add pretty printing to 'list' commandzlg3-17/+107 Also add the "--width" option to specify the maximum width of the table. 2018-09-08setup.py: Bump to alpha4 for PyPIzlg1-1/+1 2018-09-08cli: add '--raw' option to list commandzlg2-9/+45 Add '--raw' option to the list command, in addition to proper note expansion. Newline characters in notes are escaped to be friendly to scripting. This option may be shortened to '-r' at the user's convenience. In raw output mode, the information is formatted in plain pipe-delimited strings, one line per row: title|system|ownership|progress|notes ownership and progress are printed in their numeric form, consistent with the OWNERSHIP and PROGRESS dictionaries in the vgstash package. An empty notes field will result in a line ending with a pipe and no whitespace following it. 2018-09-08Add remaining filters to vgstash packagezlg1-2/+11 2018-09-04Update LICENSE to match setup.pyzlg1-80/+67 Whoops. 2018-09-03Branch off from master with pytest, tox, clickzlg16-778/+779 This commit is huge, but contains everything needed for a "proper" build system built on pytest + tox and a CLI built with click. For now, this branch will contain all new vgstash development activity until it reaches feature parity with master. The CLI is installed to pip's PATH. Only the 'init', 'add', and 'list' commands work, with only two filters. This is pre-alpha software, and is therefore not stable yet. 2018-03-18Flesh out filter types and ownership statuszlg3-82/+144 It's time for a refactor to a module; the functionality and interface are clashing. 2018-03-18README.mdown: break line correctlyzlg1-1/+1 2018-03-18add 'playlog' list filterzlg2-2/+9 This filter is used to get an idea of which games you're currently playing through, so you can prioritize games to play when you're bored and detect it when you've beaten a game but haven't marked it as such. 2018-03-13Update helpers a bitzlg1-2/+9 At present, user modification is needed to make these seamless. vgup() may need to be axed in favor of telling the user to make an alias. 2018-03-13Make VGSTASH_DB_LOCATION point to a filezlg2-21/+20 It used to point to a directory, which would then look for .vgstash.db. This behavior was kind of backwards and I don't remember why I did it that way. This change gives users more control over where they put their DB. Be sure to update your environment variable if you have it set! 2016-11-18Remove settings from helpers.shZe Libertine Gamer1-5/+0 Sourcing them in .bash_profile screws up login if they're set. 2016-11-15Correct phrasing in README.Ze Libertine Gamer1-4/+4 2016-11-13DerpZe Libertine Gamer1-0/+1 2016-11-03Improve error handling in shell scriptsZe Libertine Gamer4-3/+23 2016-10-24Correct run_again, add recursionZe Libertine Gamer1-0/+4 Loops and functions -- oh my, what a useful combination. :) 2016-10-21Add quotes to correct behavior for arglistZe Libertine Gamer1-1/+1 2016-10-14updater.sh: add recursion, error handlingZe Libertine Gamer1-43/+101 2016-10-14Correct pipe-handling behaviorZe Libertine Gamer1-1/+9 2016-10-12Clarify a method to move between platformsZe Libertine Gamer1-2/+5 Also correct a typo.