From 7ec3551f629ab267c151d35439f6eaeb1bed5691 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Mangano?= Date: Thu, 15 Feb 2024 14:20:30 +0900 Subject: [PATCH] Refresh and install the documentation files --- CMakeLists.txt | 1 + CONTRIBUTING.md | 11 +++++------ LICENSE | 2 +- README.md | 2 ++ 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index be4de3e..1b1a9db 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -51,5 +51,6 @@ include(GNUInstallDirs) install(TARGETS opustags DESTINATION "${CMAKE_INSTALL_BINDIR}") configure_file(opustags.1 . @ONLY) install(FILES "${CMAKE_BINARY_DIR}/opustags.1" DESTINATION "${CMAKE_INSTALL_MANDIR}/man1") +install(FILES CHANGELOG.md CONTRIBUTING.md LICENSE README.md DESTINATION ${CMAKE_INSTALL_DOCDIR}) add_subdirectory(t) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 493c377..d6bc316 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,6 +25,9 @@ You should check that your changes don't break the test suite by running Following these practices is important to keep the history clean, and to allow for better code reviews. +You can submit pull requests on GitHub at , +or email me your patches at . + ## History of opustags opustags is originally a small project made to fill a need to edit tags in Opus @@ -49,6 +52,8 @@ modules, and reviewed for safety. 1.3.0 was focused on correctness, and detects edge cases as early as possible, instead of hoping something will eventually fail if something is weird. +Subsequent releases have been adding new features. + ## Candidate features The code contains a few `\todo` markers where something could be improved in the @@ -59,13 +64,7 @@ More generally, here are a few features that could be added in the future: - Discouraging non-ASCII field names. - Logicial stream listing and selection for multiplexed files. - Escaping control characters with --escape. -- Dump binary packets with --binary. -- Edition of the vendor string. - Edition of the arbitrary binary block past the comments. -- Support for OpusTags packets spanning multiple pages (> 64 kB). -- Interactive edition of comments inside the EDITOR (--edit). -- Support for cover arts. -- Load tags from a file with --set-all=tags.txt. - Colored output. Don't hesitate to contact me before you do anything, I'll give you directions. diff --git a/LICENSE b/LICENSE index 730cd86..ed4f29e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2013-2018, Frédéric Mangano-Tarumi +Copyright (c) 2013-2024, Frédéric Mangano All rights reserved. Redistribution and use in source and binary forms, with or without modification, diff --git a/README.md b/README.md index 3752922..5ad1e18 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ ever be performed. opustags is tag-agnostic: you can write arbitrary key-value tags, and none of them will be treated specially. After all, common tags like TITLE or ARTIST are nothing more than conventions. +The project’s homepage is located at . + Requirements ------------