From 9d8ba866a90b42379a12797a7f7457beda45f202 Mon Sep 17 00:00:00 2001 From: Nils <> Date: Tue, 8 Jan 2019 18:45:12 +0100 Subject: [PATCH] Part of documentation moved to template --- README.md | 82 +++-- documentation/LICENSE | 430 --------------------------- documentation/README.txt | 7 - documentation/build-documentation.sh | 18 -- engine/config.py | 49 ++- template | 2 +- 6 files changed, 99 insertions(+), 489 deletions(-) delete mode 100644 documentation/LICENSE delete mode 100644 documentation/README.txt delete mode 100644 documentation/build-documentation.sh diff --git a/README.md b/README.md index 6950130..0457d10 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,85 @@ -# Patroneo -Patroneo (which is Esperanto for "Pattern") is an easy to use pattern based midi sequencer that handles the three most important musical parameters: pitch, rhythm and dynamics. +#Patroneo -This README is just a short introduction. You better read the manual, which also includes detailed instructions how to build Patroneo from source and start it. +Patroneo (which is Esperanto for "Pattern") is an easy to use pattern based midi sequencer that +handles the three most important musical parameters: pitch, rhythm and dynamics. -Workflow summary: You have tracks with one pattern each. Turn on steps in the pattern to play musical notes. Switch the patterns on and off in a sequence to create a song structure. Connect external synthesizers and samplers to create sounds. +Patroneo is primarily designed for educational purposes, where the main goal is to teach the +importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer +you can use to create real music. The constraints it presents will more likely boost your +creativity than suppressing it. -* Website https://www.laborejo.org -* Documentation and Manual https://www.laborejo.org/documentation/patroneo +Workflow summary: You have tracks with one pattern each. Turn on steps in the pattern to play +musical notes. Switch the patterns on and off in a sequence to create a song structure. +Connect external synthesizers and samplers to create sounds. -Patroneo is primarily designed for educational purposes, where the main goal is to teach the importance of patterns and repetitions in any kind of music. +This README is just a short introduction. Consult the manual (see below) for more information. -However, Patroneo is a full sequencer you can use to create real music. The constraints it presents will more likely boost your creativity than suppressing it. +# Contact and Information + +* Website https://www.laborejo.org +* Documentation and Manual https://www.laborejo.org/documentation/patroneo # Installation and Starting ## Download -Download the latest release through your package manger. -You can also build it yourself: Download the latest code release on https://www.laborejo.org/downloads and -* `./configure --prefix=/usr` -* `make` -* `sudo make install` - -Patroneo can then be started using the Non Session Manager. +If the latest release is not available through your package manger you can build it yourself: +Download the latest code release on https://www.laborejo.org/downloads and extract it. ## Dependencies * Python 3.6 (maybe earlier) * PyQt5 for Python 3 +* Fluidsynth +* Glibc +* Bash -### Build Dependencies +#### Build Dependencies +* Bash * Nuitka >= 0.6 (maybe earlier) * GCC (development is done on 8.2, but most likely you can use a much earlier version) ### Environment: * Jack Audio Connection Kit must be running -* Patroneo must be started via the Non Session Manager + +## Build +The default prefix is /usr/local +* `./configure --prefix=/usr` +* `make` +* `sudo make install` + +## Starting through the Non Session Manager after installation (recommended) + +Starting Patroneo through the Non Session Manager after you installed patroneo system-wide +is the recommended and only supported way. Start non-session-manager and load or create a new +session. Then use the button "Add Client to Session" and type in patroneo. +It should appear with an icon in the list and open its GUI. + +## Starting through NSM without building / installation + +Starting Patroneo through the Non Session Manager is possible without building or installation. +So you don't need to call the steps avobe (configure, make, make install) + +The developer uses this way to develop the software, so it will always be stable and supported. +But it is a bit less performant than building and installing it. + +After extracting the release archive create a symlink from `patroneo` into your PATH. e.g. /usr/bin +or ~/bin, if that exists on your system. + +This mode needs calfbox to be installed systemwide. Please consult https://github.com/kfoltman/calfbox + +## Starting without Non Session Manager +This is not yet implemented! + +You need to start patroneo from a terminal (or create a starter script). + +`patroneo --save DIRECTORY` + +Uses the given directory to save. The dir will be created or loaded from if already present. Use +the applications file menu to save (Ctrl+s). + +You can use this to load and save the files from an existing NSM session. If you create a new +directory you can copy it manually to an NSM session directory, but that requires renaming the +directory to append the unique ID provided by NSM. + +Closing through your window manager in this mode will actually quit the application without a +prompt to save changes. diff --git a/documentation/LICENSE b/documentation/LICENSE deleted file mode 100644 index aa44e5a..0000000 --- a/documentation/LICENSE +++ /dev/null @@ -1,430 +0,0 @@ -from: https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt - -Attribution-ShareAlike 4.0 International - -======================================================================= - -Creative Commons Corporation ("Creative Commons") is not a law firm and -does not provide legal services or legal advice. Distribution of -Creative Commons public licenses does not create a lawyer-client or -other relationship. Creative Commons makes its licenses and related -information available on an "as-is" basis. Creative Commons gives no -warranties regarding its licenses, any material licensed under their -terms and conditions, or any related information. Creative Commons -disclaims all liability for damages resulting from their use to the -fullest extent possible. - -Using Creative Commons Public Licenses - -Creative Commons public licenses provide a standard set of terms and -conditions that creators and other rights holders may use to share -original works of authorship and other material subject to copyright -and certain other rights specified in the public license below. The -following considerations are for informational purposes only, are not -exhaustive, and do not form part of our licenses. - - Considerations for licensors: Our public licenses are - intended for use by those authorized to give the public - permission to use material in ways otherwise restricted by - copyright and certain other rights. Our licenses are - irrevocable. Licensors should read and understand the terms - and conditions of the license they choose before applying it. - Licensors should also secure all rights necessary before - applying our licenses so that the public can reuse the - material as expected. Licensors should clearly mark any - material not subject to the license. This includes other CC- - licensed material, or material used under an exception or - limitation to copyright. More considerations for licensors: - wiki.creativecommons.org/Considerations_for_licensors - - Considerations for the public: By using one of our public - licenses, a licensor grants the public permission to use the - licensed material under specified terms and conditions. If - the licensor's permission is not necessary for any reason--for - example, because of any applicable exception or limitation to - copyright--then that use is not regulated by the license. Our - licenses grant only permissions under copyright and certain - other rights that a licensor has authority to grant. Use of - the licensed material may still be restricted for other - reasons, including because others have copyright or other - rights in the material. A licensor may make special requests, - such as asking that all changes be marked or described. - Although not required by our licenses, you are encouraged to - respect those requests where reasonable. More considerations - for the public: - wiki.creativecommons.org/Considerations_for_licensees - -======================================================================= - -Creative Commons Attribution-ShareAlike 4.0 International Public -License - -By exercising the Licensed Rights (defined below), You accept and agree -to be bound by the terms and conditions of this Creative Commons -Attribution-ShareAlike 4.0 International Public License ("Public -License"). To the extent this Public License may be interpreted as a -contract, You are granted the Licensed Rights in consideration of Your -acceptance of these terms and conditions, and the Licensor grants You -such rights in consideration of benefits the Licensor receives from -making the Licensed Material available under these terms and -conditions. - - -Section 1 -- Definitions. - - a. Adapted Material means material subject to Copyright and Similar - Rights that is derived from or based upon the Licensed Material - and in which the Licensed Material is translated, altered, - arranged, transformed, or otherwise modified in a manner requiring - permission under the Copyright and Similar Rights held by the - Licensor. For purposes of this Public License, where the Licensed - Material is a musical work, performance, or sound recording, - Adapted Material is always produced where the Licensed Material is - synched in timed relation with a moving image. - - b. Adapter's License means the license You apply to Your Copyright - and Similar Rights in Your contributions to Adapted Material in - accordance with the terms and conditions of this Public License. - - c. BY-SA Compatible License means a license listed at - creativecommons.org/compatiblelicenses, approved by Creative - Commons as essentially the equivalent of this Public License. - - d. Copyright and Similar Rights means copyright and/or similar rights - closely related to copyright including, without limitation, - performance, broadcast, sound recording, and Sui Generis Database - Rights, without regard to how the rights are labeled or - categorized. For purposes of this Public License, the rights - specified in Section 2(b)(1)-(2) are not Copyright and Similar - Rights. - - e. Effective Technological Measures means those measures that, in the - absence of proper authority, may not be circumvented under laws - fulfilling obligations under Article 11 of the WIPO Copyright - Treaty adopted on December 20, 1996, and/or similar international - agreements. - - f. Exceptions and Limitations means fair use, fair dealing, and/or - any other exception or limitation to Copyright and Similar Rights - that applies to Your use of the Licensed Material. - - g. License Elements means the license attributes listed in the name - of a Creative Commons Public License. The License Elements of this - Public License are Attribution and ShareAlike. - - h. Licensed Material means the artistic or literary work, database, - or other material to which the Licensor applied this Public - License. - - i. Licensed Rights means the rights granted to You subject to the - terms and conditions of this Public License, which are limited to - all Copyright and Similar Rights that apply to Your use of the - Licensed Material and that the Licensor has authority to license. - - j. Licensor means the individual(s) or entity(ies) granting rights - under this Public License. - - k. Share means to provide material to the public by any means or - process that requires permission under the Licensed Rights, such - as reproduction, public display, public performance, distribution, - dissemination, communication, or importation, and to make material - available to the public including in ways that members of the - public may access the material from a place and at a time - individually chosen by them. - - l. Sui Generis Database Rights means rights other than copyright - resulting from Directive 96/9/EC of the European Parliament and of - the Council of 11 March 1996 on the legal protection of databases, - as amended and/or succeeded, as well as other essentially - equivalent rights anywhere in the world. - - m. You means the individual or entity exercising the Licensed Rights - under this Public License. Your has a corresponding meaning. - - -Section 2 -- Scope. - - a. License grant. - - 1. Subject to the terms and conditions of this Public License, - the Licensor hereby grants You a worldwide, royalty-free, - non-sublicensable, non-exclusive, irrevocable license to - exercise the Licensed Rights in the Licensed Material to: - - a. reproduce and Share the Licensed Material, in whole or - in part; and - - b. produce, reproduce, and Share Adapted Material. - - 2. Exceptions and Limitations. For the avoidance of doubt, where - Exceptions and Limitations apply to Your use, this Public - License does not apply, and You do not need to comply with - its terms and conditions. - - 3. Term. The term of this Public License is specified in Section - 6(a). - - 4. Media and formats; technical modifications allowed. The - Licensor authorizes You to exercise the Licensed Rights in - all media and formats whether now known or hereafter created, - and to make technical modifications necessary to do so. The - Licensor waives and/or agrees not to assert any right or - authority to forbid You from making technical modifications - necessary to exercise the Licensed Rights, including - technical modifications necessary to circumvent Effective - Technological Measures. For purposes of this Public License, - simply making modifications authorized by this Section 2(a) - (4) never produces Adapted Material. - - 5. Downstream recipients. - - a. Offer from the Licensor -- Licensed Material. Every - recipient of the Licensed Material automatically - receives an offer from the Licensor to exercise the - Licensed Rights under the terms and conditions of this - Public License. - - b. Additional offer from the Licensor -- Adapted Material. - Every recipient of Adapted Material from You - automatically receives an offer from the Licensor to - exercise the Licensed Rights in the Adapted Material - under the conditions of the Adapter's License You apply. - - c. No downstream restrictions. You may not offer or impose - any additional or different terms or conditions on, or - apply any Effective Technological Measures to, the - Licensed Material if doing so restricts exercise of the - Licensed Rights by any recipient of the Licensed - Material. - - 6. No endorsement. Nothing in this Public License constitutes or - may be construed as permission to assert or imply that You - are, or that Your use of the Licensed Material is, connected - with, or sponsored, endorsed, or granted official status by, - the Licensor or others designated to receive attribution as - provided in Section 3(a)(1)(A)(i). - - b. Other rights. - - 1. Moral rights, such as the right of integrity, are not - licensed under this Public License, nor are publicity, - privacy, and/or other similar personality rights; however, to - the extent possible, the Licensor waives and/or agrees not to - assert any such rights held by the Licensor to the limited - extent necessary to allow You to exercise the Licensed - Rights, but not otherwise. - - 2. Patent and trademark rights are not licensed under this - Public License. - - 3. To the extent possible, the Licensor waives any right to - collect royalties from You for the exercise of the Licensed - Rights, whether directly or through a collecting society - under any voluntary or waivable statutory or compulsory - licensing scheme. In all other cases the Licensor expressly - reserves any right to collect such royalties. - - -Section 3 -- License Conditions. - -Your exercise of the Licensed Rights is expressly made subject to the -following conditions. - - a. Attribution. - - 1. If You Share the Licensed Material (including in modified - form), You must: - - a. retain the following if it is supplied by the Licensor - with the Licensed Material: - - i. identification of the creator(s) of the Licensed - Material and any others designated to receive - attribution, in any reasonable manner requested by - the Licensor (including by pseudonym if - designated); - - ii. a copyright notice; - - iii. a notice that refers to this Public License; - - iv. a notice that refers to the disclaimer of - warranties; - - v. a URI or hyperlink to the Licensed Material to the - extent reasonably practicable; - - b. indicate if You modified the Licensed Material and - retain an indication of any previous modifications; and - - c. indicate the Licensed Material is licensed under this - Public License, and include the text of, or the URI or - hyperlink to, this Public License. - - 2. You may satisfy the conditions in Section 3(a)(1) in any - reasonable manner based on the medium, means, and context in - which You Share the Licensed Material. For example, it may be - reasonable to satisfy the conditions by providing a URI or - hyperlink to a resource that includes the required - information. - - 3. If requested by the Licensor, You must remove any of the - information required by Section 3(a)(1)(A) to the extent - reasonably practicable. - - b. ShareAlike. - - In addition to the conditions in Section 3(a), if You Share - Adapted Material You produce, the following conditions also apply. - - 1. The Adapter's License You apply must be a Creative Commons - license with the same License Elements, this version or - later, or a BY-SA Compatible License. - - 2. You must include the text of, or the URI or hyperlink to, the - Adapter's License You apply. You may satisfy this condition - in any reasonable manner based on the medium, means, and - context in which You Share Adapted Material. - - 3. You may not offer or impose any additional or different terms - or conditions on, or apply any Effective Technological - Measures to, Adapted Material that restrict exercise of the - rights granted under the Adapter's License You apply. - - -Section 4 -- Sui Generis Database Rights. - -Where the Licensed Rights include Sui Generis Database Rights that -apply to Your use of the Licensed Material: - - a. for the avoidance of doubt, Section 2(a)(1) grants You the right - to extract, reuse, reproduce, and Share all or a substantial - portion of the contents of the database; - - b. if You include all or a substantial portion of the database - contents in a database in which You have Sui Generis Database - Rights, then the database in which You have Sui Generis Database - Rights (but not its individual contents) is Adapted Material, - - including for purposes of Section 3(b); and - c. You must comply with the conditions in Section 3(a) if You Share - all or a substantial portion of the contents of the database. - -For the avoidance of doubt, this Section 4 supplements and does not -replace Your obligations under this Public License where the Licensed -Rights include other Copyright and Similar Rights. - - -Section 5 -- Disclaimer of Warranties and Limitation of Liability. - - a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE - EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS - AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF - ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, - IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, - WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR - PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, - ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT - KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT - ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. - - b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE - TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, - NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, - INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, - COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR - USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN - ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR - DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR - IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. - - c. The disclaimer of warranties and limitation of liability provided - above shall be interpreted in a manner that, to the extent - possible, most closely approximates an absolute disclaimer and - waiver of all liability. - - -Section 6 -- Term and Termination. - - a. This Public License applies for the term of the Copyright and - Similar Rights licensed here. However, if You fail to comply with - this Public License, then Your rights under this Public License - terminate automatically. - - b. Where Your right to use the Licensed Material has terminated under - Section 6(a), it reinstates: - - 1. automatically as of the date the violation is cured, provided - it is cured within 30 days of Your discovery of the - violation; or - - 2. upon express reinstatement by the Licensor. - - For the avoidance of doubt, this Section 6(b) does not affect any - right the Licensor may have to seek remedies for Your violations - of this Public License. - - c. For the avoidance of doubt, the Licensor may also offer the - Licensed Material under separate terms or conditions or stop - distributing the Licensed Material at any time; however, doing so - will not terminate this Public License. - - d. Sections 1, 5, 6, 7, and 8 survive termination of this Public - License. - - -Section 7 -- Other Terms and Conditions. - - a. The Licensor shall not be bound by any additional or different - terms or conditions communicated by You unless expressly agreed. - - b. Any arrangements, understandings, or agreements regarding the - Licensed Material not stated herein are separate from and - independent of the terms and conditions of this Public License. - - -Section 8 -- Interpretation. - - a. For the avoidance of doubt, this Public License does not, and - shall not be interpreted to, reduce, limit, restrict, or impose - conditions on any use of the Licensed Material that could lawfully - be made without permission under this Public License. - - b. To the extent possible, if any provision of this Public License is - deemed unenforceable, it shall be automatically reformed to the - minimum extent necessary to make it enforceable. If the provision - cannot be reformed, it shall be severed from this Public License - without affecting the enforceability of the remaining terms and - conditions. - - c. No term or condition of this Public License will be waived and no - failure to comply consented to unless expressly agreed to by the - Licensor. - - d. Nothing in this Public License constitutes or may be interpreted - as a limitation upon, or waiver of, any privileges and immunities - that apply to the Licensor or You, including from the legal - processes of any jurisdiction or authority. - - -======================================================================= - -Creative Commons is not a party to its public -licenses. Notwithstanding, Creative Commons may elect to apply one of -its public licenses to material it publishes and in those instances -will be considered the “Licensor.” The text of the Creative Commons -public licenses is dedicated to the public domain under the CC0 Public -Domain Dedication. Except for the limited purpose of indicating that -material is shared under a Creative Commons public license or as -otherwise permitted by the Creative Commons policies published at -creativecommons.org/policies, Creative Commons does not authorize the -use of the trademark "Creative Commons" or any other trademark or logo -of Creative Commons without its prior written consent including, -without limitation, in connection with any unauthorized modifications -to any of its public licenses or any other arrangements, -understandings, or agreements concerning use of licensed material. For -the avoidance of doubt, this paragraph does not form part of the -public licenses. - -Creative Commons may be contacted at creativecommons.org. - diff --git a/documentation/README.txt b/documentation/README.txt deleted file mode 100644 index ca48b6d..0000000 --- a/documentation/README.txt +++ /dev/null @@ -1,7 +0,0 @@ -Run ./build-documentation.sh for html output in the /out directory. - -.adoc is asciidoctor, not simple asciidoc. - -This documentation is licensed under Creative Commons-BY-SA-4.0. -Please read the provided documentation/LICENSE file or visit -https://creativecommons.org/licenses/by-sa/4.0/legalcode diff --git a/documentation/build-documentation.sh b/documentation/build-documentation.sh deleted file mode 100644 index bb271f4..0000000 --- a/documentation/build-documentation.sh +++ /dev/null @@ -1,18 +0,0 @@ -#!/bin/sh - -#The documentation is built statically and does not belong to the normal build process with configure and make -#Its updating is part of the development process, not packaging and running. -#The correct out/ dir is already part of git. - -set -e -asciidoctor index.adoc -o out/index.html - -asciidoctor german.adoc -o out/german.html -cp overview-german.png out/overview-german.png - -asciidoctor english.adoc -o out/english.html -cp overview-english.png out/overview-english.png - -#cp *-quickstart*.mp4 out/ - -cp favicon.* out/ diff --git a/engine/config.py b/engine/config.py index 9fb764d..c0ff9eb 100644 --- a/engine/config.py +++ b/engine/config.py @@ -5,36 +5,53 @@ METADATA={ #The pretty name of this program. Used for NSM display and Jack client name - #Can contain everything a linux file/path supports. Never change this or it will break the + #Can contain everything a linux file/path supports. Never change this or it will break the #session, making your file unable to load and destroying saved Jack connections. - "name" : "Patroneo", + "name" : "Patroneo", #Set this to the name the user types into a terminal. #MUST be the same as the binary name as well as the name in configure. #Program reports that as proc title so you can killall it by name. #Should not contain spaces or special characters. We use this as save file extension as well #to distinguish between compatible program versions. In basic programs this will just be e.g. - #patroneo. But in complex programs with a bright future it will be "laborejo1" "laborejo2" etc. - "shortName" : "patroneo", - - "version" : "1.1", - "year" : "2019", - "author" : "Laborejo Software Suite", + #patroneo. But in complex programs with a bright future it will be "laborejo1" "laborejo2" etc. + "shortName" : "patroneo", + + "version" : "1.1", + "year" : "2019", + "author" : "Laborejo Software Suite", "url" : "https://www.laborejo.org/patroneo", - + "supportedLanguages" : {"German":"de.qm"}, - + #Show the About Dialog the first time the program starts up. This is the initial state for a #new instance in NSM, not the saved state! Decide on how annoying it would be for every new #instance to show about. Fluajho does not show it because you add it many times into a session. #Patroneo does because its only added once. - "showAboutDialogFirstStart" : True, - + "showAboutDialogFirstStart" : True, + #If your program handles very small duration with n-tuplets you should increase D4. #This will not be visible to the outside jack world - "quarterNoteInTicks" : 96, - - #How many audio outputs do you want? must be pairs. These are just unconnected jack outputs + "quarterNoteInTicks" : 96, + + #How many audio outputs do you want? must be pairs. These are just unconnected jack outputs #that need to be connected internally to instrument outputs like fluidsynth - "cboxOutputs" : 2 * 0, + "cboxOutputs" : 2 * 0, + + + #Various strings for the README + #Extra whitespace will be stripped so we don't need to worry about docstring indentation + "description" : """ +Patroneo (which is Esperanto for "Pattern") is an easy to use pattern based midi sequencer that +handles the three most important musical parameters: pitch, rhythm and dynamics. + +Patroneo is primarily designed for educational purposes, where the main goal is to teach the +importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer +you can use to create real music. The constraints it presents will more likely boost your +creativity than suppressing it.""" + "\n" + """ +Workflow summary: You have tracks with one pattern each. Turn on steps in the pattern to play +musical notes. Switch the patterns on and off in a sequence to create a song structure. +Connect external synthesizers and samplers to create sounds.""", + + "dependencies" : "\n".join("* "+dep for dep in ("Fluidsynth", "Glibc", "Bash")), } diff --git a/template b/template index b348a9b..39620cc 160000 --- a/template +++ b/template @@ -1 +1 @@ -Subproject commit b348a9bc9259d20debdfa0c3f96d130cc25aab4d +Subproject commit 39620cc8b97a0dc79f388f7fd723131378251c5a