evox 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +93 -20
  4. data/_config.yml +4 -0
  5. data/bin/evox +0 -0
  6. data/lib/evox/version.rb +1 -1
  7. metadata +3 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 44ae05ff4c63074d1ab2574ad9bc9cdd1036681dd79a2336d92d2520a7fd6ffa
4
- data.tar.gz: fcc009f3d676dfa40252379bdc851a0f81f5d4e980ce39e8f926cdf0fab77077
3
+ metadata.gz: e7de6fa311ee8ada5170d63526280c2c672e6b8eda49faf0a2cf81d0c1b65bb0
4
+ data.tar.gz: 51c7987c89595cbe90cac19ede3ef11ac059dae03cee75d85d541cc5f1a39407
5
5
  SHA512:
6
- metadata.gz: 5ef7fe3a745fc5f8865bb7135cddebf0b29fd648523f0c569dcc091ebeed76b040e4be360ee7c261574a65537dc99f7b2b0398fc06216ebd8857625b9f6dd45e
7
- data.tar.gz: 60d5b4e2748c342b411920631d2215110884e756125593722b5ce0f821217ace8e73add80aaaf06a3834acc7e6ecc0ea3b3ebaea2b46687154ee59513c0ee72c
6
+ metadata.gz: f856f8d65a6b363fa517272fe963265de3aad173aeb4a7824975ce40181e1c694edbae2eb169d5bd21d0ecf8f46221c8acf8d8bc4414a7010505ca10acfbe788
7
+ data.tar.gz: 7f08151917e0f2877d5f984dc6cae0e365d5196b519e306701e242d8a2a396b386c8884e9f70d6aba028b7362bb570518feca7af8beee8bc2f39bf69cb1e04fb
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- evox (1.0.0)
4
+ evox (1.0.1)
5
5
  commander
6
6
  prawn
7
7
 
data/README.md CHANGED
@@ -1,38 +1,111 @@
1
- # Evox
1
+ # EvoX
2
+ EvoX is a PDF songbook generator for the masses. Making it easy for anyone to create and maintain their very own songbook.
2
3
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/evox`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+ #### Why
5
+ I wanted to create a songbook of the songs I like to play, but being a programmer it made a total sense to build a songbook builder first.
4
6
 
5
- TODO: Delete this and the text above, and describe your gem
7
+ #### Features
8
+ - It makes a PDF Songbook (obviously).
9
+ - Super sexy cover page, with logo support.
10
+ - It features a super simple plain-text markup language making it easy for people to create & share songs.
11
+ - Multiple column support.
12
+ - Per song font setting and column size adjustments.
13
+ - Table of content with page numbers.
6
14
 
7
15
  ## Installation
8
-
9
- Add this line to your application's Gemfile:
10
-
11
- ```ruby
12
- gem 'evox'
13
- ```
14
-
15
- And then execute:
16
-
17
- $ bundle
18
-
19
- Or install it yourself as:
16
+ Install evox with:
20
17
 
21
18
  $ gem install evox
22
19
 
23
20
  ## Usage
24
21
 
25
- TODO: Write usage instructions here
22
+ Create a directory to house your songbook
23
+
24
+ $ mkdir superbook
25
+ $ cd superbook
26
+
27
+ Initialize the songbook
28
+
29
+ $ evox init
30
+
31
+ This will create 3 different directories __book__, __cover__, and __songs__.
32
+
33
+ Next, generate the sample song book.
34
+
35
+ $ evox generate
36
+
37
+ This will create the book.pdf inside the book folder.
38
+
39
+ ### The Cover
40
+ Inside the cover folder there are 2 files, the __config.yml__ and __logo.png__.
41
+ The logo file is just an example you can replace with your own.
42
+
43
+ The __config.yml__ allows you to adjust the cover heading, subheading, logo-size, and footer text. You can also change the name of the logo file.
44
+
45
+ ```yaml
46
+ header:
47
+ top_padding: 20
48
+ title: 'The Great Book of Songs'
49
+ title_size: 35
50
+ subtitle: 'Version 0.5'
51
+ subtitle_size: 15
52
+ bottom_padding: 50
53
+ logo:
54
+ image: logo.png
55
+ width: 393.5
56
+ height: 457
57
+ footer:
58
+ title: 'Compiled by Leonid Medovyy'
59
+ title_size: 25
60
+ ```
26
61
 
27
- ## Development
62
+ ### The Songs
63
+ The songs are just files with .evox extension that live inside the __songs__ directory, and are printed in alphabetical order when the songbook is generated.
64
+
65
+ The song settings are located in between the double equal signs. Font size, column gutter size and total column width can be adjusted.
66
+ ```yaml
67
+ ==
68
+ name: Free Falling
69
+ author: Tom Petty
70
+ font: 9.0
71
+ column_width: 610
72
+ gutter: 5
73
+ ==
74
+ ```
28
75
 
29
- After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
76
 
31
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
77
+ The columns are created by placing lyrics inside double dashes.
78
+
79
+ Lyrics themselves start with spaces, and chords start with a period.
80
+ This concept is inspired by [OpenSong](http://www.opensong.org/).
81
+ ```yaml
82
+ --
83
+ . C F F C G
84
+ She's a good girl, loves her mama
85
+ . C F F C G
86
+ Loves Jesus and America too
87
+ . C F F C G
88
+ She's a good girl, crazy 'bout Elvis
89
+ . C F F C G
90
+ Loves horses and her boyfriend too
91
+ --
92
+
93
+ --
94
+ . C F F C G
95
+ It's a long day of livin' in Reseda
96
+ . C F F C G
97
+ There's a freeway runnin' through the yard
98
+ . C F F C G
99
+ And I'm a bad boy, 'cause I don't even miss her
100
+ . C F F C G
101
+ I'm a bad boy for breakin' her heart
102
+ --
103
+ ```
104
+
32
105
 
33
106
  ## Contributing
34
107
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/evox.
108
+ Bug reports and pull requests are welcome on GitHub at https://github.com/leouofa/evox.
36
109
 
37
110
  ## License
38
111
 
data/_config.yml ADDED
@@ -0,0 +1,4 @@
1
+ theme: jekyll-theme-minimal
2
+ title: 'Project Evox'
3
+ description: 'The PDF Songbook Generator For The Masses'
4
+ logo: 'lib/templates/logo.png'
data/bin/evox CHANGED
File without changes
data/lib/evox/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Evox
2
- VERSION = "1.0.0"
2
+ VERSION = "1.0.1"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: evox
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Leonid Medovyy
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-04-02 00:00:00.000000000 Z
11
+ date: 2020-04-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -95,6 +95,7 @@ files:
95
95
  - LICENSE.txt
96
96
  - README.md
97
97
  - Rakefile
98
+ - _config.yml
98
99
  - bin/console
99
100
  - bin/evox
100
101
  - bin/setup